@robinmordasiewicz/f5xc-api-mcp 1.0.91-2601040555 → 2.0.2-2601050111
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generator/dependency-extractor.d.ts +0 -4
- package/dist/generator/dependency-extractor.d.ts.map +1 -1
- package/dist/generator/dependency-extractor.js +0 -4
- package/dist/generator/dependency-extractor.js.map +1 -1
- package/dist/generator/domain-metadata.d.ts.map +1 -1
- package/dist/generator/domain-metadata.js +18 -15
- package/dist/generator/domain-metadata.js.map +1 -1
- package/dist/generator/naming/acronyms.d.ts +0 -18
- package/dist/generator/naming/acronyms.d.ts.map +1 -1
- package/dist/generator/naming/acronyms.js +0 -27
- package/dist/generator/naming/acronyms.js.map +1 -1
- package/dist/generator/naming/index.d.ts +5 -2
- package/dist/generator/naming/index.d.ts.map +1 -1
- package/dist/generator/naming/index.js +5 -2
- package/dist/generator/naming/index.js.map +1 -1
- package/dist/generator/naming/volterra-mapping.d.ts +4 -72
- package/dist/generator/naming/volterra-mapping.d.ts.map +1 -1
- package/dist/generator/naming/volterra-mapping.js +4 -189
- package/dist/generator/naming/volterra-mapping.js.map +1 -1
- package/dist/generator/openapi-parser.d.ts +0 -12
- package/dist/generator/openapi-parser.d.ts.map +1 -1
- package/dist/generator/openapi-parser.js +1 -240
- package/dist/generator/openapi-parser.js.map +1 -1
- package/dist/generator/transformers/normalize-examples.d.ts +2 -3
- package/dist/generator/transformers/normalize-examples.d.ts.map +1 -1
- package/dist/generator/transformers/normalize-examples.js +2 -3
- package/dist/generator/transformers/normalize-examples.js.map +1 -1
- package/dist/tools/generated/admin_console_and_ui/index.d.ts.map +1 -1
- package/dist/tools/generated/admin_console_and_ui/index.js +2 -12
- package/dist/tools/generated/admin_console_and_ui/index.js.map +1 -1
- package/dist/tools/generated/ai_services/index.d.ts.map +1 -1
- package/dist/tools/generated/ai_services/index.js +4 -16
- package/dist/tools/generated/ai_services/index.js.map +1 -1
- package/dist/tools/generated/api/index.d.ts.map +1 -1
- package/dist/tools/generated/api/index.js +77 -309
- package/dist/tools/generated/api/index.js.map +1 -1
- package/dist/tools/generated/authentication/index.d.ts.map +1 -1
- package/dist/tools/generated/authentication/index.js +7 -34
- package/dist/tools/generated/authentication/index.js.map +1 -1
- package/dist/tools/generated/bigip/index.d.ts.map +1 -1
- package/dist/tools/generated/bigip/index.js +43 -156
- package/dist/tools/generated/bigip/index.js.map +1 -1
- package/dist/tools/generated/billing_and_usage/index.d.ts.map +1 -1
- package/dist/tools/generated/billing_and_usage/index.js +19 -94
- package/dist/tools/generated/billing_and_usage/index.js.map +1 -1
- package/dist/tools/generated/blindfold/index.d.ts.map +1 -1
- package/dist/tools/generated/blindfold/index.js +30 -162
- package/dist/tools/generated/blindfold/index.js.map +1 -1
- package/dist/tools/generated/bot_and_threat_defense/index.d.ts.map +1 -1
- package/dist/tools/generated/bot_and_threat_defense/index.js +25 -107
- package/dist/tools/generated/bot_and_threat_defense/index.js.map +1 -1
- package/dist/tools/generated/cdn/index.d.ts.map +1 -1
- package/dist/tools/generated/cdn/index.js +30 -116
- package/dist/tools/generated/cdn/index.js.map +1 -1
- package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
- package/dist/tools/generated/ce_management/index.js +37 -162
- package/dist/tools/generated/ce_management/index.js.map +1 -1
- package/dist/tools/generated/certificates/index.d.ts.map +1 -1
- package/dist/tools/generated/certificates/index.js +40 -132
- package/dist/tools/generated/certificates/index.js.map +1 -1
- package/dist/tools/generated/cloud_infrastructure/index.d.ts.map +1 -1
- package/dist/tools/generated/cloud_infrastructure/index.js +47 -170
- package/dist/tools/generated/cloud_infrastructure/index.js.map +1 -1
- package/dist/tools/generated/container_services/index.d.ts.map +1 -1
- package/dist/tools/generated/container_services/index.js +154 -114
- package/dist/tools/generated/container_services/index.js.map +1 -1
- package/dist/tools/generated/data_and_privacy_security/index.d.ts.map +1 -1
- package/dist/tools/generated/data_and_privacy_security/index.js +133 -90
- package/dist/tools/generated/data_and_privacy_security/index.js.map +1 -1
- package/dist/tools/generated/data_intelligence/index.d.ts.map +1 -1
- package/dist/tools/generated/data_intelligence/index.js +11 -56
- package/dist/tools/generated/data_intelligence/index.js.map +1 -1
- package/dist/tools/generated/ddos/index.d.ts.map +1 -1
- package/dist/tools/generated/ddos/index.js +988 -445
- package/dist/tools/generated/ddos/index.js.map +1 -1
- package/dist/tools/generated/dependency-graph.json +2709 -396
- package/dist/tools/generated/dns/index.d.ts.map +1 -1
- package/dist/tools/generated/dns/index.js +45 -229
- package/dist/tools/generated/dns/index.js.map +1 -1
- package/dist/tools/generated/managed_kubernetes/index.d.ts.map +1 -1
- package/dist/tools/generated/managed_kubernetes/index.js +90 -205
- package/dist/tools/generated/managed_kubernetes/index.js.map +1 -1
- package/dist/tools/generated/marketplace/index.d.ts.map +1 -1
- package/dist/tools/generated/marketplace/index.js +46 -203
- package/dist/tools/generated/marketplace/index.js.map +1 -1
- package/dist/tools/generated/network/index.d.ts.map +1 -1
- package/dist/tools/generated/network/index.js +175 -629
- package/dist/tools/generated/network/index.js.map +1 -1
- package/dist/tools/generated/network_security/index.d.ts.map +1 -1
- package/dist/tools/generated/network_security/index.js +114 -427
- package/dist/tools/generated/network_security/index.js.map +1 -1
- package/dist/tools/generated/nginx_one/index.d.ts.map +1 -1
- package/dist/tools/generated/nginx_one/index.js +18 -74
- package/dist/tools/generated/nginx_one/index.js.map +1 -1
- package/dist/tools/generated/object_storage/index.d.ts.map +1 -1
- package/dist/tools/generated/object_storage/index.js +7 -66
- package/dist/tools/generated/object_storage/index.js.map +1 -1
- package/dist/tools/generated/observability/index.d.ts.map +1 -1
- package/dist/tools/generated/observability/index.js +43 -282
- package/dist/tools/generated/observability/index.js.map +1 -1
- package/dist/tools/generated/rate_limiting/index.d.ts.map +1 -1
- package/dist/tools/generated/rate_limiting/index.js +30 -99
- package/dist/tools/generated/rate_limiting/index.js.map +1 -1
- package/dist/tools/generated/secops_and_incident_response/index.d.ts.map +1 -1
- package/dist/tools/generated/secops_and_incident_response/index.js +10 -33
- package/dist/tools/generated/secops_and_incident_response/index.js.map +1 -1
- package/dist/tools/generated/service_mesh/index.d.ts.map +1 -1
- package/dist/tools/generated/service_mesh/index.js +151 -658
- package/dist/tools/generated/service_mesh/index.js.map +1 -1
- package/dist/tools/generated/shape/index.d.ts.map +1 -1
- package/dist/tools/generated/shape/index.js +2668 -961
- package/dist/tools/generated/shape/index.js.map +1 -1
- package/dist/tools/generated/sites/index.d.ts.map +1 -1
- package/dist/tools/generated/sites/index.js +151 -622
- package/dist/tools/generated/sites/index.js.map +1 -1
- package/dist/tools/generated/statistics/index.d.ts.map +1 -1
- package/dist/tools/generated/statistics/index.js +78 -373
- package/dist/tools/generated/statistics/index.js.map +1 -1
- package/dist/tools/generated/support/index.d.ts.map +1 -1
- package/dist/tools/generated/support/index.js +43 -290
- package/dist/tools/generated/support/index.js.map +1 -1
- package/dist/tools/generated/telemetry_and_insights/index.d.ts.map +1 -1
- package/dist/tools/generated/telemetry_and_insights/index.js +16 -90
- package/dist/tools/generated/telemetry_and_insights/index.js.map +1 -1
- package/dist/tools/generated/tenant_and_identity/index.d.ts.map +1 -1
- package/dist/tools/generated/tenant_and_identity/index.js +130 -623
- package/dist/tools/generated/tenant_and_identity/index.js.map +1 -1
- package/dist/tools/generated/threat_campaign/index.d.ts.map +1 -1
- package/dist/tools/generated/threat_campaign/index.js +1 -4
- package/dist/tools/generated/threat_campaign/index.js.map +1 -1
- package/dist/tools/generated/users/index.d.ts.map +1 -1
- package/dist/tools/generated/users/index.js +13 -69
- package/dist/tools/generated/users/index.js.map +1 -1
- package/dist/tools/generated/virtual/index.d.ts.map +1 -1
- package/dist/tools/generated/virtual/index.js +129 -554
- package/dist/tools/generated/virtual/index.js.map +1 -1
- package/dist/tools/generated/waf/index.d.ts.map +1 -1
- package/dist/tools/generated/waf/index.js +42 -178
- package/dist/tools/generated/waf/index.js.map +1 -1
- package/dist/version.d.ts +2 -2
- package/dist/version.d.ts.map +1 -1
- package/dist/version.js +2 -2
- package/dist/version.js.map +1 -1
- package/manifest.json +20 -6
- package/package.json +1 -1
- package/specs/domains/admin_console_and_ui.json +140 -117
- package/specs/domains/ai_services.json +359 -285
- package/specs/domains/api.json +1710 -1808
- package/specs/domains/authentication.json +345 -302
- package/specs/domains/bigip.json +939 -1014
- package/specs/domains/billing_and_usage.json +724 -638
- package/specs/domains/blindfold.json +1027 -1011
- package/specs/domains/bot_and_threat_defense.json +542 -500
- package/specs/domains/cdn.json +3179 -3756
- package/specs/domains/ce_management.json +1607 -1667
- package/specs/domains/certificates.json +569 -560
- package/specs/domains/cloud_infrastructure.json +1295 -1342
- package/specs/domains/container_services.json +931 -1047
- package/specs/domains/data_and_privacy_security.json +489 -505
- package/specs/domains/data_intelligence.json +523 -497
- package/specs/domains/ddos.json +1473 -1334
- package/specs/domains/dns.json +1494 -1680
- package/specs/domains/managed_kubernetes.json +709 -759
- package/specs/domains/marketplace.json +1092 -1105
- package/specs/domains/network.json +2598 -2759
- package/specs/domains/network_security.json +2196 -2335
- package/specs/domains/nginx_one.json +444 -424
- package/specs/domains/object_storage.json +131 -146
- package/specs/domains/observability.json +1681 -1604
- package/specs/domains/rate_limiting.json +440 -438
- package/specs/domains/secops_and_incident_response.json +242 -220
- package/specs/domains/service_mesh.json +1530 -1561
- package/specs/domains/shape.json +5193 -4964
- package/specs/domains/sites.json +6092 -6475
- package/specs/domains/statistics.json +3453 -3314
- package/specs/domains/support.json +1369 -1127
- package/specs/domains/telemetry_and_insights.json +1052 -1021
- package/specs/domains/tenant_and_identity.json +3407 -3091
- package/specs/domains/threat_campaign.json +916 -975
- package/specs/domains/users.json +422 -366
- package/specs/domains/virtual.json +4194 -4982
- package/specs/domains/vpm_and_node_management.json +6 -6
- package/specs/domains/waf.json +1769 -1780
- package/specs/index.json +463 -675
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Ai Services",
|
|
5
5
|
"description": "Query handling through inference routing with production and test modes. Positive and negative quality markers with detailed categorization capture assistant performance. Streaming connections support authenticated access, subscription lifecycles, and feature flags. IP provisioning services allocate infrastructure resources for model workloads across distributed systems.",
|
|
6
|
-
"version": "
|
|
6
|
+
"version": "2.0.2",
|
|
7
7
|
"contact": {
|
|
8
8
|
"name": "F5 Distributed Cloud",
|
|
9
9
|
"url": "https://docs.cloud.f5.com"
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"variables": {
|
|
23
23
|
"tenant": {
|
|
24
24
|
"default": "example-corp",
|
|
25
|
-
"description": "F5 Distributed Cloud tenant identifier (e.g.,
|
|
25
|
+
"description": "F5 Distributed Cloud tenant identifier (e.g., example-company, acme-inc)"
|
|
26
26
|
},
|
|
27
27
|
"console_url": {
|
|
28
28
|
"default": "console.ves.volterra.io",
|
|
@@ -187,7 +187,7 @@
|
|
|
187
187
|
"schema": {
|
|
188
188
|
"type": "string"
|
|
189
189
|
},
|
|
190
|
-
"x-
|
|
190
|
+
"x-f5xc-example": "system"
|
|
191
191
|
}
|
|
192
192
|
],
|
|
193
193
|
"requestBody": {
|
|
@@ -394,7 +394,7 @@
|
|
|
394
394
|
"schema": {
|
|
395
395
|
"type": "string"
|
|
396
396
|
},
|
|
397
|
-
"x-
|
|
397
|
+
"x-f5xc-example": "system"
|
|
398
398
|
}
|
|
399
399
|
],
|
|
400
400
|
"requestBody": {
|
|
@@ -601,7 +601,7 @@
|
|
|
601
601
|
"schema": {
|
|
602
602
|
"type": "string"
|
|
603
603
|
},
|
|
604
|
-
"x-
|
|
604
|
+
"x-f5xc-example": "system"
|
|
605
605
|
}
|
|
606
606
|
],
|
|
607
607
|
"requestBody": {
|
|
@@ -808,7 +808,7 @@
|
|
|
808
808
|
"schema": {
|
|
809
809
|
"type": "string"
|
|
810
810
|
},
|
|
811
|
-
"x-
|
|
811
|
+
"x-f5xc-example": "system"
|
|
812
812
|
}
|
|
813
813
|
],
|
|
814
814
|
"requestBody": {
|
|
@@ -2312,12 +2312,12 @@
|
|
|
2312
2312
|
"x-ves-validation-rules": {
|
|
2313
2313
|
"ves.io.schema.rules.string.max_len": "4096"
|
|
2314
2314
|
},
|
|
2315
|
+
"x-f5xc-example": "Response is biased",
|
|
2315
2316
|
"x-validation-rules": {
|
|
2316
2317
|
"ves.io.schema.rules.string.max_len": "4096"
|
|
2317
2318
|
},
|
|
2318
2319
|
"minLength": 0,
|
|
2319
|
-
"
|
|
2320
|
-
"x-ves-required-for": {
|
|
2320
|
+
"x-f5xc-required-for": {
|
|
2321
2321
|
"minimum_config": false,
|
|
2322
2322
|
"create": false,
|
|
2323
2323
|
"update": false,
|
|
@@ -2330,9 +2330,10 @@
|
|
|
2330
2330
|
"title": "Namespace",
|
|
2331
2331
|
"x-displayname": "Namespace",
|
|
2332
2332
|
"x-ves-example": "System",
|
|
2333
|
+
"x-f5xc-example": "system",
|
|
2333
2334
|
"minLength": 0,
|
|
2334
2335
|
"maxLength": 6,
|
|
2335
|
-
"x-
|
|
2336
|
+
"x-f5xc-required-for": {
|
|
2336
2337
|
"minimum_config": false,
|
|
2337
2338
|
"create": false,
|
|
2338
2339
|
"update": false,
|
|
@@ -2340,7 +2341,7 @@
|
|
|
2340
2341
|
},
|
|
2341
2342
|
"x-original-maxLength": 1024,
|
|
2342
2343
|
"x-reconciled-from-discovery": true,
|
|
2343
|
-
"x-reconciled-at": "2026-01-
|
|
2344
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169156+00:00"
|
|
2344
2345
|
},
|
|
2345
2346
|
"negative_feedback": {
|
|
2346
2347
|
"$ref": "#/components/schemas/ai_assistantNegativeFeedbackDetails"
|
|
@@ -2354,9 +2355,10 @@
|
|
|
2354
2355
|
"title": "Query",
|
|
2355
2356
|
"x-displayname": "Query",
|
|
2356
2357
|
"x-ves-example": "How to investigate request log.",
|
|
2358
|
+
"x-f5xc-example": "How to investigate request log",
|
|
2357
2359
|
"minLength": 0,
|
|
2358
2360
|
"maxLength": 1024,
|
|
2359
|
-
"x-
|
|
2361
|
+
"x-f5xc-required-for": {
|
|
2360
2362
|
"minimum_config": false,
|
|
2361
2363
|
"create": false,
|
|
2362
2364
|
"update": false,
|
|
@@ -2372,13 +2374,13 @@
|
|
|
2372
2374
|
"x-ves-validation-rules": {
|
|
2373
2375
|
"ves.io.schema.rules.string.pattern": "^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$"
|
|
2374
2376
|
},
|
|
2377
|
+
"x-f5xc-example": "07e03bc6-81d4-4c86-a865-67b5763fe294",
|
|
2375
2378
|
"x-validation-rules": {
|
|
2376
2379
|
"ves.io.schema.rules.string.pattern": "^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$"
|
|
2377
2380
|
},
|
|
2378
2381
|
"minLength": 0,
|
|
2379
2382
|
"maxLength": 1024,
|
|
2380
|
-
"
|
|
2381
|
-
"x-ves-required-for": {
|
|
2383
|
+
"x-f5xc-required-for": {
|
|
2382
2384
|
"minimum_config": false,
|
|
2383
2385
|
"create": false,
|
|
2384
2386
|
"update": false,
|
|
@@ -2387,7 +2389,7 @@
|
|
|
2387
2389
|
"x-field-mutability": "read-only"
|
|
2388
2390
|
}
|
|
2389
2391
|
},
|
|
2390
|
-
"x-
|
|
2392
|
+
"x-f5xc-minimum-configuration": {
|
|
2391
2393
|
"description": "Minimum configuration for ai_assistantAIAssistantQueryFeedbackRequest",
|
|
2392
2394
|
"required_fields": [
|
|
2393
2395
|
"comment",
|
|
@@ -2402,7 +2404,7 @@
|
|
|
2402
2404
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"comment\": \"value\",\n \"namespace\": \"value\",\n \"negative_feedback\": \"value\",\n \"positive_feedback\": \"value\",\n \"query\": \"value\"\n }\n}",
|
|
2403
2405
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/ai_assistant_a_i_assistant_query_feedback_requests\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
2404
2406
|
},
|
|
2405
|
-
"x-
|
|
2407
|
+
"x-f5xc-cli-domain": "ai_services"
|
|
2406
2408
|
},
|
|
2407
2409
|
"ai_assistantAIAssistantQueryRequest": {
|
|
2408
2410
|
"type": "object",
|
|
@@ -2417,9 +2419,10 @@
|
|
|
2417
2419
|
"title": "Current_query.",
|
|
2418
2420
|
"x-displayname": "Current query.",
|
|
2419
2421
|
"x-ves-example": "Explain security event 07e03bc6-81d4-4c86-a865-67b5763fe294.",
|
|
2422
|
+
"x-f5xc-example": "Explain security event 07e03bc6-81d4-4c86-a865-67b5763fe294",
|
|
2420
2423
|
"minLength": 0,
|
|
2421
2424
|
"maxLength": 1024,
|
|
2422
|
-
"x-
|
|
2425
|
+
"x-f5xc-required-for": {
|
|
2423
2426
|
"minimum_config": false,
|
|
2424
2427
|
"create": false,
|
|
2425
2428
|
"update": false,
|
|
@@ -2432,9 +2435,10 @@
|
|
|
2432
2435
|
"title": "Namespace",
|
|
2433
2436
|
"x-displayname": "Namespace",
|
|
2434
2437
|
"x-ves-example": "System",
|
|
2438
|
+
"x-f5xc-example": "system",
|
|
2435
2439
|
"minLength": 0,
|
|
2436
2440
|
"maxLength": 6,
|
|
2437
|
-
"x-
|
|
2441
|
+
"x-f5xc-required-for": {
|
|
2438
2442
|
"minimum_config": false,
|
|
2439
2443
|
"create": false,
|
|
2440
2444
|
"update": false,
|
|
@@ -2442,10 +2446,10 @@
|
|
|
2442
2446
|
},
|
|
2443
2447
|
"x-original-maxLength": 1024,
|
|
2444
2448
|
"x-reconciled-from-discovery": true,
|
|
2445
|
-
"x-reconciled-at": "2026-01-
|
|
2449
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169176+00:00"
|
|
2446
2450
|
}
|
|
2447
2451
|
},
|
|
2448
|
-
"x-
|
|
2452
|
+
"x-f5xc-minimum-configuration": {
|
|
2449
2453
|
"description": "Minimum configuration for ai_assistantAIAssistantQueryRequest",
|
|
2450
2454
|
"required_fields": [
|
|
2451
2455
|
"current_query",
|
|
@@ -2456,7 +2460,7 @@
|
|
|
2456
2460
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"current_query\": \"value\",\n \"namespace\": \"value\"\n }\n}",
|
|
2457
2461
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/ai_assistant_a_i_assistant_query_requests\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
2458
2462
|
},
|
|
2459
|
-
"x-
|
|
2463
|
+
"x-f5xc-cli-domain": "ai_services"
|
|
2460
2464
|
},
|
|
2461
2465
|
"ai_assistantAIAssistantQueryResponse": {
|
|
2462
2466
|
"type": "object",
|
|
@@ -2472,9 +2476,10 @@
|
|
|
2472
2476
|
"title": "Current_query.",
|
|
2473
2477
|
"x-displayname": "Current query.",
|
|
2474
2478
|
"x-ves-example": "Explain security event 07e03bc6-81d4-4c86-a865-67b5763fe294.",
|
|
2479
|
+
"x-f5xc-example": "Explain security event 07e03bc6-81d4-4c86-a865-67b5763fe294",
|
|
2475
2480
|
"minLength": 0,
|
|
2476
2481
|
"maxLength": 1024,
|
|
2477
|
-
"x-
|
|
2482
|
+
"x-f5xc-required-for": {
|
|
2478
2483
|
"minimum_config": false,
|
|
2479
2484
|
"create": false,
|
|
2480
2485
|
"update": false,
|
|
@@ -2496,11 +2501,11 @@
|
|
|
2496
2501
|
"x-ves-validation-rules": {
|
|
2497
2502
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
2498
2503
|
},
|
|
2504
|
+
"x-f5xc-example": "Explain following violation in whole namespace",
|
|
2499
2505
|
"x-validation-rules": {
|
|
2500
2506
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
2501
2507
|
},
|
|
2502
|
-
"
|
|
2503
|
-
"x-ves-required-for": {
|
|
2508
|
+
"x-f5xc-required-for": {
|
|
2504
2509
|
"minimum_config": false,
|
|
2505
2510
|
"create": false,
|
|
2506
2511
|
"update": false,
|
|
@@ -2525,13 +2530,13 @@
|
|
|
2525
2530
|
"x-ves-validation-rules": {
|
|
2526
2531
|
"ves.io.schema.rules.string.pattern": "^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$"
|
|
2527
2532
|
},
|
|
2533
|
+
"x-f5xc-example": "07e03bc6-81d4-4c86-a865-67b5763fe294",
|
|
2528
2534
|
"x-validation-rules": {
|
|
2529
2535
|
"ves.io.schema.rules.string.pattern": "^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$"
|
|
2530
2536
|
},
|
|
2531
2537
|
"minLength": 0,
|
|
2532
2538
|
"maxLength": 1024,
|
|
2533
|
-
"
|
|
2534
|
-
"x-ves-required-for": {
|
|
2539
|
+
"x-f5xc-required-for": {
|
|
2535
2540
|
"minimum_config": false,
|
|
2536
2541
|
"create": false,
|
|
2537
2542
|
"update": false,
|
|
@@ -2546,7 +2551,7 @@
|
|
|
2546
2551
|
"$ref": "#/components/schemas/widgetWidgetResponse"
|
|
2547
2552
|
}
|
|
2548
2553
|
},
|
|
2549
|
-
"x-
|
|
2554
|
+
"x-f5xc-minimum-configuration": {
|
|
2550
2555
|
"description": "Minimum configuration for ai_assistantAIAssistantQueryResponse",
|
|
2551
2556
|
"required_fields": [
|
|
2552
2557
|
"current_query",
|
|
@@ -2564,7 +2569,7 @@
|
|
|
2564
2569
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"current_query\": \"value\",\n \"explain_log\": \"value\",\n \"follow_up_queries\": \"value\",\n \"gen_dashboard_filter\": \"value\",\n \"generic_response\": \"value\"\n }\n}",
|
|
2565
2570
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/ai_assistant_a_i_assistant_query_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
2566
2571
|
},
|
|
2567
|
-
"x-
|
|
2572
|
+
"x-f5xc-cli-domain": "ai_services"
|
|
2568
2573
|
},
|
|
2569
2574
|
"ai_assistantNegativeFeedbackDetails": {
|
|
2570
2575
|
"type": "object",
|
|
@@ -2586,13 +2591,12 @@
|
|
|
2586
2591
|
"ves.io.schema.rules.repeated.items.enum.defined_only": "true",
|
|
2587
2592
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
2588
2593
|
},
|
|
2594
|
+
"x-f5xc-example": "Inaccurate data",
|
|
2589
2595
|
"x-validation-rules": {
|
|
2590
2596
|
"ves.io.schema.rules.repeated.items.enum.defined_only": "true",
|
|
2591
2597
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
2592
2598
|
},
|
|
2593
|
-
"
|
|
2594
|
-
"ves.io.schema.rules.repeated.unique": "true",
|
|
2595
|
-
"x-ves-required-for": {
|
|
2599
|
+
"x-f5xc-required-for": {
|
|
2596
2600
|
"minimum_config": false,
|
|
2597
2601
|
"create": false,
|
|
2598
2602
|
"update": false,
|
|
@@ -2600,7 +2604,7 @@
|
|
|
2600
2604
|
}
|
|
2601
2605
|
}
|
|
2602
2606
|
},
|
|
2603
|
-
"x-
|
|
2607
|
+
"x-f5xc-minimum-configuration": {
|
|
2604
2608
|
"description": "Minimum configuration for ai_assistantNegativeFeedbackDetails",
|
|
2605
2609
|
"required_fields": [
|
|
2606
2610
|
"remarks"
|
|
@@ -2610,7 +2614,7 @@
|
|
|
2610
2614
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"remarks\": \"value\"\n }\n}",
|
|
2611
2615
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/ai_assistant_negative_feedback_detailses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
2612
2616
|
},
|
|
2613
|
-
"x-
|
|
2617
|
+
"x-f5xc-cli-domain": "ai_services"
|
|
2614
2618
|
},
|
|
2615
2619
|
"ai_assistantNegativeFeedbackType": {
|
|
2616
2620
|
"type": "string",
|
|
@@ -2626,7 +2630,7 @@
|
|
|
2626
2630
|
"default": "OTHER",
|
|
2627
2631
|
"x-displayname": "",
|
|
2628
2632
|
"x-ves-proto-enum": "ves.io.schema.ai_assistant.NegativeFeedbackType",
|
|
2629
|
-
"x-
|
|
2633
|
+
"x-f5xc-minimum-configuration": {
|
|
2630
2634
|
"description": "Minimum configuration for ai_assistantNegativeFeedbackType",
|
|
2631
2635
|
"required_fields": [],
|
|
2632
2636
|
"mutually_exclusive_groups": [],
|
|
@@ -2634,7 +2638,7 @@
|
|
|
2634
2638
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
2635
2639
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/ai_assistant_negative_feedback_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
2636
2640
|
},
|
|
2637
|
-
"x-
|
|
2641
|
+
"x-f5xc-cli-domain": "ai_services"
|
|
2638
2642
|
},
|
|
2639
2643
|
"ai_assistantcommonUnitType": {
|
|
2640
2644
|
"type": "string",
|
|
@@ -2649,7 +2653,7 @@
|
|
|
2649
2653
|
"default": "UNIT_TYPE_NONE",
|
|
2650
2654
|
"x-displayname": "Unit Type",
|
|
2651
2655
|
"x-ves-proto-enum": "ves.io.schema.ai_assistant.common.UnitType",
|
|
2652
|
-
"x-
|
|
2656
|
+
"x-f5xc-minimum-configuration": {
|
|
2653
2657
|
"description": "Minimum configuration for ai_assistantcommonUnitType",
|
|
2654
2658
|
"required_fields": [],
|
|
2655
2659
|
"mutually_exclusive_groups": [],
|
|
@@ -2657,7 +2661,7 @@
|
|
|
2657
2661
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
2658
2662
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/ai_assistantcommon_unit_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
2659
2663
|
},
|
|
2660
|
-
"x-
|
|
2664
|
+
"x-f5xc-cli-domain": "ai_services"
|
|
2661
2665
|
},
|
|
2662
2666
|
"ai_assistantexplain_log_recordAction": {
|
|
2663
2667
|
"type": "string",
|
|
@@ -2672,7 +2676,7 @@
|
|
|
2672
2676
|
"default": "ACTION_NONE",
|
|
2673
2677
|
"x-displayname": "Action",
|
|
2674
2678
|
"x-ves-proto-enum": "ves.io.schema.ai_assistant.explain_log_record.Action",
|
|
2675
|
-
"x-
|
|
2679
|
+
"x-f5xc-minimum-configuration": {
|
|
2676
2680
|
"description": "Minimum configuration for ai_assistantexplain_log_recordAction",
|
|
2677
2681
|
"required_fields": [],
|
|
2678
2682
|
"mutually_exclusive_groups": [],
|
|
@@ -2680,7 +2684,7 @@
|
|
|
2680
2684
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
2681
2685
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/ai_assistantexplain_log_record_actions\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
2682
2686
|
},
|
|
2683
|
-
"x-
|
|
2687
|
+
"x-f5xc-cli-domain": "statistics"
|
|
2684
2688
|
},
|
|
2685
2689
|
"commonCellProperties": {
|
|
2686
2690
|
"type": "object",
|
|
@@ -2690,7 +2694,7 @@
|
|
|
2690
2694
|
"$ref": "#/components/schemas/commonStatusStyle"
|
|
2691
2695
|
}
|
|
2692
2696
|
},
|
|
2693
|
-
"x-
|
|
2697
|
+
"x-f5xc-minimum-configuration": {
|
|
2694
2698
|
"description": "Minimum configuration for commonCellProperties",
|
|
2695
2699
|
"required_fields": [
|
|
2696
2700
|
"status_style"
|
|
@@ -2700,7 +2704,7 @@
|
|
|
2700
2704
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"status_style\": \"value\"\n }\n}",
|
|
2701
2705
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_cell_propertieses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
2702
2706
|
},
|
|
2703
|
-
"x-
|
|
2707
|
+
"x-f5xc-cli-domain": "other"
|
|
2704
2708
|
},
|
|
2705
2709
|
"commonColourType": {
|
|
2706
2710
|
"type": "string",
|
|
@@ -2718,7 +2722,7 @@
|
|
|
2718
2722
|
"default": "COLOUR_TYPE_NONE",
|
|
2719
2723
|
"x-displayname": "Colour Type.",
|
|
2720
2724
|
"x-ves-proto-enum": "ves.io.schema.ai_assistant.common.ColourType",
|
|
2721
|
-
"x-
|
|
2725
|
+
"x-f5xc-minimum-configuration": {
|
|
2722
2726
|
"description": "Minimum configuration for commonColourType",
|
|
2723
2727
|
"required_fields": [],
|
|
2724
2728
|
"mutually_exclusive_groups": [],
|
|
@@ -2726,7 +2730,7 @@
|
|
|
2726
2730
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
2727
2731
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_colour_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
2728
2732
|
},
|
|
2729
|
-
"x-
|
|
2733
|
+
"x-f5xc-cli-domain": "other"
|
|
2730
2734
|
},
|
|
2731
2735
|
"commonColumnType": {
|
|
2732
2736
|
"type": "string",
|
|
@@ -2742,7 +2746,7 @@
|
|
|
2742
2746
|
"default": "COLUMN_TYPE_NONE",
|
|
2743
2747
|
"x-displayname": "Column Type.",
|
|
2744
2748
|
"x-ves-proto-enum": "ves.io.schema.ai_assistant.common.ColumnType",
|
|
2745
|
-
"x-
|
|
2749
|
+
"x-f5xc-minimum-configuration": {
|
|
2746
2750
|
"description": "Minimum configuration for commonColumnType",
|
|
2747
2751
|
"required_fields": [],
|
|
2748
2752
|
"mutually_exclusive_groups": [],
|
|
@@ -2750,7 +2754,7 @@
|
|
|
2750
2754
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
2751
2755
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_column_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
2752
2756
|
},
|
|
2753
|
-
"x-
|
|
2757
|
+
"x-f5xc-cli-domain": "other"
|
|
2754
2758
|
},
|
|
2755
2759
|
"commonDashboardLink": {
|
|
2756
2760
|
"type": "object",
|
|
@@ -2769,13 +2773,13 @@
|
|
|
2769
2773
|
"x-ves-validation-rules": {
|
|
2770
2774
|
"ves.io.schema.rules.message.required": "true"
|
|
2771
2775
|
},
|
|
2776
|
+
"x-f5xc-example": "db_link",
|
|
2772
2777
|
"x-validation-rules": {
|
|
2773
2778
|
"ves.io.schema.rules.message.required": "true"
|
|
2774
2779
|
},
|
|
2775
2780
|
"minLength": 0,
|
|
2776
2781
|
"maxLength": 16,
|
|
2777
|
-
"
|
|
2778
|
-
"x-ves-required-for": {
|
|
2782
|
+
"x-f5xc-required-for": {
|
|
2779
2783
|
"minimum_config": false,
|
|
2780
2784
|
"create": false,
|
|
2781
2785
|
"update": false,
|
|
@@ -2783,7 +2787,7 @@
|
|
|
2783
2787
|
},
|
|
2784
2788
|
"x-original-maxLength": 1024,
|
|
2785
2789
|
"x-reconciled-from-discovery": true,
|
|
2786
|
-
"x-reconciled-at": "2026-01-
|
|
2790
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169203+00:00"
|
|
2787
2791
|
},
|
|
2788
2792
|
"log_filters": {
|
|
2789
2793
|
"type": "array",
|
|
@@ -2793,7 +2797,7 @@
|
|
|
2793
2797
|
"$ref": "#/components/schemas/commonLogFilter"
|
|
2794
2798
|
},
|
|
2795
2799
|
"x-displayname": "Logs Filter.",
|
|
2796
|
-
"x-
|
|
2800
|
+
"x-f5xc-required-for": {
|
|
2797
2801
|
"minimum_config": false,
|
|
2798
2802
|
"create": false,
|
|
2799
2803
|
"update": false,
|
|
@@ -2806,9 +2810,10 @@
|
|
|
2806
2810
|
"title": "Namespace",
|
|
2807
2811
|
"x-displayname": "Namespace",
|
|
2808
2812
|
"x-ves-example": "System",
|
|
2813
|
+
"x-f5xc-example": "system",
|
|
2809
2814
|
"minLength": 0,
|
|
2810
2815
|
"maxLength": 6,
|
|
2811
|
-
"x-
|
|
2816
|
+
"x-f5xc-required-for": {
|
|
2812
2817
|
"minimum_config": false,
|
|
2813
2818
|
"create": false,
|
|
2814
2819
|
"update": false,
|
|
@@ -2816,7 +2821,7 @@
|
|
|
2816
2821
|
},
|
|
2817
2822
|
"x-original-maxLength": 1024,
|
|
2818
2823
|
"x-reconciled-from-discovery": true,
|
|
2819
|
-
"x-reconciled-at": "2026-01-
|
|
2824
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169209+00:00"
|
|
2820
2825
|
},
|
|
2821
2826
|
"object_name": {
|
|
2822
2827
|
"type": "string",
|
|
@@ -2824,9 +2829,10 @@
|
|
|
2824
2829
|
"title": "Object_name.",
|
|
2825
2830
|
"x-displayname": "Object name.",
|
|
2826
2831
|
"x-ves-example": "VES-I/O-HTTP-loadbalancer-prod-NGINX.",
|
|
2832
|
+
"x-f5xc-example": "ves-io-http-loadbalancer-prod-nginx",
|
|
2827
2833
|
"minLength": 0,
|
|
2828
2834
|
"maxLength": 1024,
|
|
2829
|
-
"x-
|
|
2835
|
+
"x-f5xc-required-for": {
|
|
2830
2836
|
"minimum_config": false,
|
|
2831
2837
|
"create": false,
|
|
2832
2838
|
"update": false,
|
|
@@ -2839,9 +2845,10 @@
|
|
|
2839
2845
|
"title": "Time_range.",
|
|
2840
2846
|
"x-displayname": "Time Range.",
|
|
2841
2847
|
"x-ves-example": "604800",
|
|
2848
|
+
"x-f5xc-example": "604800",
|
|
2842
2849
|
"minLength": 0,
|
|
2843
2850
|
"maxLength": 1024,
|
|
2844
|
-
"x-
|
|
2851
|
+
"x-f5xc-required-for": {
|
|
2845
2852
|
"minimum_config": false,
|
|
2846
2853
|
"create": false,
|
|
2847
2854
|
"update": false,
|
|
@@ -2854,9 +2861,10 @@
|
|
|
2854
2861
|
"title": "Title",
|
|
2855
2862
|
"x-displayname": "Title",
|
|
2856
2863
|
"x-ves-example": "Security Analytics lb1.",
|
|
2864
|
+
"x-f5xc-example": "Security Analytics lb1",
|
|
2857
2865
|
"minLength": 0,
|
|
2858
2866
|
"maxLength": 6,
|
|
2859
|
-
"x-
|
|
2867
|
+
"x-f5xc-required-for": {
|
|
2860
2868
|
"minimum_config": false,
|
|
2861
2869
|
"create": false,
|
|
2862
2870
|
"update": false,
|
|
@@ -2864,13 +2872,13 @@
|
|
|
2864
2872
|
},
|
|
2865
2873
|
"x-original-maxLength": 1024,
|
|
2866
2874
|
"x-reconciled-from-discovery": true,
|
|
2867
|
-
"x-reconciled-at": "2026-01-
|
|
2875
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169217+00:00"
|
|
2868
2876
|
},
|
|
2869
2877
|
"type": {
|
|
2870
2878
|
"$ref": "#/components/schemas/commonDashboardLinkType"
|
|
2871
2879
|
}
|
|
2872
2880
|
},
|
|
2873
|
-
"x-
|
|
2881
|
+
"x-f5xc-minimum-configuration": {
|
|
2874
2882
|
"description": "Minimum configuration for commonDashboardLink",
|
|
2875
2883
|
"required_fields": [
|
|
2876
2884
|
"key",
|
|
@@ -2886,7 +2894,7 @@
|
|
|
2886
2894
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"key\": \"value\",\n \"log_filters\": \"value\",\n \"namespace\": \"value\",\n \"object_name\": \"value\",\n \"time_range\": \"value\"\n }\n}",
|
|
2887
2895
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_dashboard_links\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
2888
2896
|
},
|
|
2889
|
-
"x-
|
|
2897
|
+
"x-f5xc-cli-domain": "other"
|
|
2890
2898
|
},
|
|
2891
2899
|
"commonDashboardLinkType": {
|
|
2892
2900
|
"type": "string",
|
|
@@ -2911,7 +2919,7 @@
|
|
|
2911
2919
|
"default": "SECURITY_ANALYTICS_EVENTS",
|
|
2912
2920
|
"x-displayname": "Link Type",
|
|
2913
2921
|
"x-ves-proto-enum": "ves.io.schema.ai_assistant.common.DashboardLinkType",
|
|
2914
|
-
"x-
|
|
2922
|
+
"x-f5xc-minimum-configuration": {
|
|
2915
2923
|
"description": "Minimum configuration for commonDashboardLinkType",
|
|
2916
2924
|
"required_fields": [],
|
|
2917
2925
|
"mutually_exclusive_groups": [],
|
|
@@ -2919,7 +2927,7 @@
|
|
|
2919
2927
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
2920
2928
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_dashboard_link_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
2921
2929
|
},
|
|
2922
|
-
"x-
|
|
2930
|
+
"x-f5xc-cli-domain": "other"
|
|
2923
2931
|
},
|
|
2924
2932
|
"commonDisplay": {
|
|
2925
2933
|
"type": "object",
|
|
@@ -2943,11 +2951,11 @@
|
|
|
2943
2951
|
"x-ves-validation-rules": {
|
|
2944
2952
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
2945
2953
|
},
|
|
2954
|
+
"x-f5xc-example": "Bold Italic",
|
|
2946
2955
|
"x-validation-rules": {
|
|
2947
2956
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
2948
2957
|
},
|
|
2949
|
-
"
|
|
2950
|
-
"x-ves-required-for": {
|
|
2958
|
+
"x-f5xc-required-for": {
|
|
2951
2959
|
"minimum_config": false,
|
|
2952
2960
|
"create": false,
|
|
2953
2961
|
"update": false,
|
|
@@ -2955,7 +2963,7 @@
|
|
|
2955
2963
|
}
|
|
2956
2964
|
}
|
|
2957
2965
|
},
|
|
2958
|
-
"x-
|
|
2966
|
+
"x-f5xc-minimum-configuration": {
|
|
2959
2967
|
"description": "Minimum configuration for commonDisplay",
|
|
2960
2968
|
"required_fields": [
|
|
2961
2969
|
"colour",
|
|
@@ -2967,7 +2975,7 @@
|
|
|
2967
2975
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"colour\": \"value\",\n \"display_type\": \"value\",\n \"formats\": \"value\"\n }\n}",
|
|
2968
2976
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_displaies\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
2969
2977
|
},
|
|
2970
|
-
"x-
|
|
2978
|
+
"x-f5xc-cli-domain": "other"
|
|
2971
2979
|
},
|
|
2972
2980
|
"commonDisplayType": {
|
|
2973
2981
|
"type": "string",
|
|
@@ -2985,7 +2993,7 @@
|
|
|
2985
2993
|
"default": "DISPLAY_TYPE_NONE",
|
|
2986
2994
|
"x-displayname": "DisplayType Type.",
|
|
2987
2995
|
"x-ves-proto-enum": "ves.io.schema.ai_assistant.common.DisplayType",
|
|
2988
|
-
"x-
|
|
2996
|
+
"x-f5xc-minimum-configuration": {
|
|
2989
2997
|
"description": "Minimum configuration for commonDisplayType",
|
|
2990
2998
|
"required_fields": [],
|
|
2991
2999
|
"mutually_exclusive_groups": [],
|
|
@@ -2993,7 +3001,7 @@
|
|
|
2993
3001
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
2994
3002
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_display_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
2995
3003
|
},
|
|
2996
|
-
"x-
|
|
3004
|
+
"x-f5xc-cli-domain": "other"
|
|
2997
3005
|
},
|
|
2998
3006
|
"commonFieldProperties": {
|
|
2999
3007
|
"type": "object",
|
|
@@ -3011,9 +3019,10 @@
|
|
|
3011
3019
|
"title": "Name",
|
|
3012
3020
|
"x-displayname": "Name",
|
|
3013
3021
|
"x-ves-example": "Provider",
|
|
3022
|
+
"x-f5xc-example": "provider",
|
|
3014
3023
|
"minLength": 0,
|
|
3015
3024
|
"maxLength": 16,
|
|
3016
|
-
"x-
|
|
3025
|
+
"x-f5xc-required-for": {
|
|
3017
3026
|
"minimum_config": false,
|
|
3018
3027
|
"create": false,
|
|
3019
3028
|
"update": false,
|
|
@@ -3021,7 +3030,7 @@
|
|
|
3021
3030
|
},
|
|
3022
3031
|
"x-original-maxLength": 1024,
|
|
3023
3032
|
"x-reconciled-from-discovery": true,
|
|
3024
|
-
"x-reconciled-at": "2026-01-
|
|
3033
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169231+00:00"
|
|
3025
3034
|
},
|
|
3026
3035
|
"title": {
|
|
3027
3036
|
"type": "string",
|
|
@@ -3029,9 +3038,10 @@
|
|
|
3029
3038
|
"title": "Title",
|
|
3030
3039
|
"x-displayname": "Title",
|
|
3031
3040
|
"x-ves-example": "Site Name",
|
|
3041
|
+
"x-f5xc-example": "Site Name",
|
|
3032
3042
|
"minLength": 0,
|
|
3033
3043
|
"maxLength": 6,
|
|
3034
|
-
"x-
|
|
3044
|
+
"x-f5xc-required-for": {
|
|
3035
3045
|
"minimum_config": false,
|
|
3036
3046
|
"create": false,
|
|
3037
3047
|
"update": false,
|
|
@@ -3039,7 +3049,7 @@
|
|
|
3039
3049
|
},
|
|
3040
3050
|
"x-original-maxLength": 1024,
|
|
3041
3051
|
"x-reconciled-from-discovery": true,
|
|
3042
|
-
"x-reconciled-at": "2026-01-
|
|
3052
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169235+00:00"
|
|
3043
3053
|
},
|
|
3044
3054
|
"tooltip": {
|
|
3045
3055
|
"type": "string",
|
|
@@ -3048,7 +3058,7 @@
|
|
|
3048
3058
|
"x-displayname": "Tooltip",
|
|
3049
3059
|
"minLength": 0,
|
|
3050
3060
|
"maxLength": 1024,
|
|
3051
|
-
"x-
|
|
3061
|
+
"x-f5xc-required-for": {
|
|
3052
3062
|
"minimum_config": false,
|
|
3053
3063
|
"create": false,
|
|
3054
3064
|
"update": false,
|
|
@@ -3059,7 +3069,7 @@
|
|
|
3059
3069
|
"$ref": "#/components/schemas/ai_assistantcommonUnitType"
|
|
3060
3070
|
}
|
|
3061
3071
|
},
|
|
3062
|
-
"x-
|
|
3072
|
+
"x-f5xc-minimum-configuration": {
|
|
3063
3073
|
"description": "Minimum configuration for commonFieldProperties",
|
|
3064
3074
|
"required_fields": [
|
|
3065
3075
|
"data_type",
|
|
@@ -3074,7 +3084,7 @@
|
|
|
3074
3084
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"data_type\": \"value\",\n \"display\": \"value\",\n \"name\": \"value\",\n \"title\": \"value\",\n \"tooltip\": \"value\"\n }\n}",
|
|
3075
3085
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_field_propertieses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3076
3086
|
},
|
|
3077
|
-
"x-
|
|
3087
|
+
"x-f5xc-cli-domain": "other"
|
|
3078
3088
|
},
|
|
3079
3089
|
"commonFilterOperator": {
|
|
3080
3090
|
"type": "string",
|
|
@@ -3087,7 +3097,7 @@
|
|
|
3087
3097
|
"default": "IN",
|
|
3088
3098
|
"x-displayname": "Filter Operator.",
|
|
3089
3099
|
"x-ves-proto-enum": "ves.io.schema.ai_assistant.common.FilterOperator",
|
|
3090
|
-
"x-
|
|
3100
|
+
"x-f5xc-minimum-configuration": {
|
|
3091
3101
|
"description": "Minimum configuration for commonFilterOperator",
|
|
3092
3102
|
"required_fields": [],
|
|
3093
3103
|
"mutually_exclusive_groups": [],
|
|
@@ -3095,7 +3105,7 @@
|
|
|
3095
3105
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
3096
3106
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_filter_operators\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3097
3107
|
},
|
|
3098
|
-
"x-
|
|
3108
|
+
"x-f5xc-cli-domain": "other"
|
|
3099
3109
|
},
|
|
3100
3110
|
"commonFormatType": {
|
|
3101
3111
|
"type": "string",
|
|
@@ -3111,7 +3121,7 @@
|
|
|
3111
3121
|
"default": "FORMAT_TYPE_NONE",
|
|
3112
3122
|
"x-displayname": "Format Type.",
|
|
3113
3123
|
"x-ves-proto-enum": "ves.io.schema.ai_assistant.common.FormatType",
|
|
3114
|
-
"x-
|
|
3124
|
+
"x-f5xc-minimum-configuration": {
|
|
3115
3125
|
"description": "Minimum configuration for commonFormatType",
|
|
3116
3126
|
"required_fields": [],
|
|
3117
3127
|
"mutually_exclusive_groups": [],
|
|
@@ -3119,7 +3129,7 @@
|
|
|
3119
3129
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
3120
3130
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_format_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3121
3131
|
},
|
|
3122
|
-
"x-
|
|
3132
|
+
"x-f5xc-cli-domain": "other"
|
|
3123
3133
|
},
|
|
3124
3134
|
"commonGenericLink": {
|
|
3125
3135
|
"type": "object",
|
|
@@ -3138,13 +3148,13 @@
|
|
|
3138
3148
|
"x-ves-validation-rules": {
|
|
3139
3149
|
"ves.io.schema.rules.message.required": "true"
|
|
3140
3150
|
},
|
|
3151
|
+
"x-f5xc-example": "db_link",
|
|
3141
3152
|
"x-validation-rules": {
|
|
3142
3153
|
"ves.io.schema.rules.message.required": "true"
|
|
3143
3154
|
},
|
|
3144
3155
|
"minLength": 0,
|
|
3145
3156
|
"maxLength": 16,
|
|
3146
|
-
"
|
|
3147
|
-
"x-ves-required-for": {
|
|
3157
|
+
"x-f5xc-required-for": {
|
|
3148
3158
|
"minimum_config": false,
|
|
3149
3159
|
"create": false,
|
|
3150
3160
|
"update": false,
|
|
@@ -3152,7 +3162,7 @@
|
|
|
3152
3162
|
},
|
|
3153
3163
|
"x-original-maxLength": 1024,
|
|
3154
3164
|
"x-reconciled-from-discovery": true,
|
|
3155
|
-
"x-reconciled-at": "2026-01-
|
|
3165
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169243+00:00"
|
|
3156
3166
|
},
|
|
3157
3167
|
"title": {
|
|
3158
3168
|
"type": "string",
|
|
@@ -3160,9 +3170,10 @@
|
|
|
3160
3170
|
"title": "Title",
|
|
3161
3171
|
"x-displayname": "Title",
|
|
3162
3172
|
"x-ves-example": "Security Analytics lb1.",
|
|
3173
|
+
"x-f5xc-example": "Security Analytics lb1",
|
|
3163
3174
|
"minLength": 0,
|
|
3164
3175
|
"maxLength": 6,
|
|
3165
|
-
"x-
|
|
3176
|
+
"x-f5xc-required-for": {
|
|
3166
3177
|
"minimum_config": false,
|
|
3167
3178
|
"create": false,
|
|
3168
3179
|
"update": false,
|
|
@@ -3170,7 +3181,7 @@
|
|
|
3170
3181
|
},
|
|
3171
3182
|
"x-original-maxLength": 1024,
|
|
3172
3183
|
"x-reconciled-from-discovery": true,
|
|
3173
|
-
"x-reconciled-at": "2026-01-
|
|
3184
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169248+00:00"
|
|
3174
3185
|
},
|
|
3175
3186
|
"url": {
|
|
3176
3187
|
"type": "string",
|
|
@@ -3178,10 +3189,11 @@
|
|
|
3178
3189
|
"title": "URL",
|
|
3179
3190
|
"x-displayname": "URL",
|
|
3180
3191
|
"x-ves-example": "https://datatracker.ietf.org/doc/HTML/rfc3986.",
|
|
3192
|
+
"x-f5xc-example": "https://datatracker.ietf.org/doc/html/rfc3986",
|
|
3181
3193
|
"format": "uri",
|
|
3182
3194
|
"minLength": 0,
|
|
3183
3195
|
"maxLength": 1024,
|
|
3184
|
-
"x-
|
|
3196
|
+
"x-f5xc-required-for": {
|
|
3185
3197
|
"minimum_config": false,
|
|
3186
3198
|
"create": false,
|
|
3187
3199
|
"update": false,
|
|
@@ -3189,7 +3201,7 @@
|
|
|
3189
3201
|
}
|
|
3190
3202
|
}
|
|
3191
3203
|
},
|
|
3192
|
-
"x-
|
|
3204
|
+
"x-f5xc-minimum-configuration": {
|
|
3193
3205
|
"description": "Minimum configuration for commonGenericLink",
|
|
3194
3206
|
"required_fields": [
|
|
3195
3207
|
"key",
|
|
@@ -3201,7 +3213,7 @@
|
|
|
3201
3213
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"key\": \"value\",\n \"title\": \"value\",\n \"url\": \"value\"\n }\n}",
|
|
3202
3214
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_generic_links\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3203
3215
|
},
|
|
3204
|
-
"x-
|
|
3216
|
+
"x-f5xc-cli-domain": "other"
|
|
3205
3217
|
},
|
|
3206
3218
|
"commonGenericResponse": {
|
|
3207
3219
|
"type": "object",
|
|
@@ -3220,7 +3232,8 @@
|
|
|
3220
3232
|
"format": "boolean",
|
|
3221
3233
|
"x-displayname": "Is_error",
|
|
3222
3234
|
"x-ves-example": "True",
|
|
3223
|
-
"x-
|
|
3235
|
+
"x-f5xc-example": "true",
|
|
3236
|
+
"x-f5xc-required-for": {
|
|
3224
3237
|
"minimum_config": false,
|
|
3225
3238
|
"create": false,
|
|
3226
3239
|
"update": false,
|
|
@@ -3233,9 +3246,10 @@
|
|
|
3233
3246
|
"title": "Summary",
|
|
3234
3247
|
"x-displayname": "Summary",
|
|
3235
3248
|
"x-ves-example": "Query not supported.",
|
|
3249
|
+
"x-f5xc-example": "Query not supported",
|
|
3236
3250
|
"minLength": 0,
|
|
3237
3251
|
"maxLength": 1024,
|
|
3238
|
-
"x-
|
|
3252
|
+
"x-f5xc-required-for": {
|
|
3239
3253
|
"minimum_config": false,
|
|
3240
3254
|
"create": false,
|
|
3241
3255
|
"update": false,
|
|
@@ -3243,7 +3257,7 @@
|
|
|
3243
3257
|
}
|
|
3244
3258
|
}
|
|
3245
3259
|
},
|
|
3246
|
-
"x-
|
|
3260
|
+
"x-f5xc-minimum-configuration": {
|
|
3247
3261
|
"description": "Minimum configuration for commonGenericResponse",
|
|
3248
3262
|
"required_fields": [
|
|
3249
3263
|
"error",
|
|
@@ -3255,7 +3269,7 @@
|
|
|
3255
3269
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"error\": \"value\",\n \"is_error\": \"value\",\n \"summary\": \"value\"\n }\n}",
|
|
3256
3270
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_generic_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3257
3271
|
},
|
|
3258
|
-
"x-
|
|
3272
|
+
"x-f5xc-cli-domain": "other"
|
|
3259
3273
|
},
|
|
3260
3274
|
"commonLink": {
|
|
3261
3275
|
"type": "object",
|
|
@@ -3272,7 +3286,7 @@
|
|
|
3272
3286
|
"$ref": "#/components/schemas/commonGenericLink"
|
|
3273
3287
|
}
|
|
3274
3288
|
},
|
|
3275
|
-
"x-
|
|
3289
|
+
"x-f5xc-minimum-configuration": {
|
|
3276
3290
|
"description": "Minimum configuration for commonLink",
|
|
3277
3291
|
"required_fields": [
|
|
3278
3292
|
"dashboard_link",
|
|
@@ -3283,7 +3297,7 @@
|
|
|
3283
3297
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"dashboard_link\": \"value\",\n \"generic_link\": \"value\"\n }\n}",
|
|
3284
3298
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_links\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3285
3299
|
},
|
|
3286
|
-
"x-
|
|
3300
|
+
"x-f5xc-cli-domain": "other"
|
|
3287
3301
|
},
|
|
3288
3302
|
"commonLogFilter": {
|
|
3289
3303
|
"type": "object",
|
|
@@ -3298,9 +3312,10 @@
|
|
|
3298
3312
|
"title": "Key",
|
|
3299
3313
|
"x-displayname": "Key",
|
|
3300
3314
|
"x-ves-example": "Attack_types.name.",
|
|
3315
|
+
"x-f5xc-example": "attack_types.name",
|
|
3301
3316
|
"minLength": 0,
|
|
3302
3317
|
"maxLength": 16,
|
|
3303
|
-
"x-
|
|
3318
|
+
"x-f5xc-required-for": {
|
|
3304
3319
|
"minimum_config": false,
|
|
3305
3320
|
"create": false,
|
|
3306
3321
|
"update": false,
|
|
@@ -3308,7 +3323,7 @@
|
|
|
3308
3323
|
},
|
|
3309
3324
|
"x-original-maxLength": 1024,
|
|
3310
3325
|
"x-reconciled-from-discovery": true,
|
|
3311
|
-
"x-reconciled-at": "2026-01-
|
|
3326
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169262+00:00"
|
|
3312
3327
|
},
|
|
3313
3328
|
"op": {
|
|
3314
3329
|
"$ref": "#/components/schemas/commonFilterOperator"
|
|
@@ -3325,11 +3340,11 @@
|
|
|
3325
3340
|
"x-ves-validation-rules": {
|
|
3326
3341
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
3327
3342
|
},
|
|
3343
|
+
"x-f5xc-example": "ATTACK_TYPE_CROSS_SITE_SCRIPTING",
|
|
3328
3344
|
"x-validation-rules": {
|
|
3329
3345
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
3330
3346
|
},
|
|
3331
|
-
"
|
|
3332
|
-
"x-ves-required-for": {
|
|
3347
|
+
"x-f5xc-required-for": {
|
|
3333
3348
|
"minimum_config": false,
|
|
3334
3349
|
"create": false,
|
|
3335
3350
|
"update": false,
|
|
@@ -3337,7 +3352,7 @@
|
|
|
3337
3352
|
}
|
|
3338
3353
|
}
|
|
3339
3354
|
},
|
|
3340
|
-
"x-
|
|
3355
|
+
"x-f5xc-minimum-configuration": {
|
|
3341
3356
|
"description": "Minimum configuration for commonLogFilter",
|
|
3342
3357
|
"required_fields": [
|
|
3343
3358
|
"key",
|
|
@@ -3349,7 +3364,7 @@
|
|
|
3349
3364
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"key\": \"value\",\n \"op\": \"value\",\n \"values\": \"value\"\n }\n}",
|
|
3350
3365
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_log_filters\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3351
3366
|
},
|
|
3352
|
-
"x-
|
|
3367
|
+
"x-f5xc-cli-domain": "statistics"
|
|
3353
3368
|
},
|
|
3354
3369
|
"commonOverlayContent": {
|
|
3355
3370
|
"type": "object",
|
|
@@ -3367,9 +3382,10 @@
|
|
|
3367
3382
|
"title": "Title",
|
|
3368
3383
|
"x-displayname": "Title",
|
|
3369
3384
|
"x-ves-example": "Security Analytics lb1.",
|
|
3385
|
+
"x-f5xc-example": "Security Analytics lb1",
|
|
3370
3386
|
"minLength": 0,
|
|
3371
3387
|
"maxLength": 6,
|
|
3372
|
-
"x-
|
|
3388
|
+
"x-f5xc-required-for": {
|
|
3373
3389
|
"minimum_config": false,
|
|
3374
3390
|
"create": false,
|
|
3375
3391
|
"update": false,
|
|
@@ -3377,13 +3393,13 @@
|
|
|
3377
3393
|
},
|
|
3378
3394
|
"x-original-maxLength": 1024,
|
|
3379
3395
|
"x-reconciled-from-discovery": true,
|
|
3380
|
-
"x-reconciled-at": "2026-01-
|
|
3396
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169271+00:00"
|
|
3381
3397
|
},
|
|
3382
3398
|
"type": {
|
|
3383
3399
|
"$ref": "#/components/schemas/commonDashboardLinkType"
|
|
3384
3400
|
}
|
|
3385
3401
|
},
|
|
3386
|
-
"x-
|
|
3402
|
+
"x-f5xc-minimum-configuration": {
|
|
3387
3403
|
"description": "Minimum configuration for commonOverlayContent",
|
|
3388
3404
|
"required_fields": [
|
|
3389
3405
|
"data",
|
|
@@ -3395,7 +3411,7 @@
|
|
|
3395
3411
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"data\": \"value\",\n \"title\": \"value\",\n \"type\": \"value\"\n }\n}",
|
|
3396
3412
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_overlay_contents\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3397
3413
|
},
|
|
3398
|
-
"x-
|
|
3414
|
+
"x-f5xc-cli-domain": "other"
|
|
3399
3415
|
},
|
|
3400
3416
|
"commonOverlayData": {
|
|
3401
3417
|
"type": "object",
|
|
@@ -3410,9 +3426,10 @@
|
|
|
3410
3426
|
"title": "Priority",
|
|
3411
3427
|
"x-displayname": "Priority",
|
|
3412
3428
|
"x-ves-example": "Normal",
|
|
3429
|
+
"x-f5xc-example": "Normal",
|
|
3413
3430
|
"minLength": 0,
|
|
3414
3431
|
"maxLength": 1024,
|
|
3415
|
-
"x-
|
|
3432
|
+
"x-f5xc-required-for": {
|
|
3416
3433
|
"minimum_config": false,
|
|
3417
3434
|
"create": false,
|
|
3418
3435
|
"update": false,
|
|
@@ -3425,9 +3442,10 @@
|
|
|
3425
3442
|
"title": "Product data.",
|
|
3426
3443
|
"x-displayname": "Product Data.",
|
|
3427
3444
|
"x-ves-example": "Site X is in Failed state for 2 reasons. Customer Tunnel Interface Down and Site Heartbeat Down.",
|
|
3445
|
+
"x-f5xc-example": "Site X is in Failed state for 2 reasons. Customer Tunnel Interface Down and Site Heartbeat Down",
|
|
3428
3446
|
"minLength": 0,
|
|
3429
3447
|
"maxLength": 1024,
|
|
3430
|
-
"x-
|
|
3448
|
+
"x-f5xc-required-for": {
|
|
3431
3449
|
"minimum_config": false,
|
|
3432
3450
|
"create": false,
|
|
3433
3451
|
"update": false,
|
|
@@ -3440,9 +3458,10 @@
|
|
|
3440
3458
|
"title": "Subject",
|
|
3441
3459
|
"x-displayname": "Subject",
|
|
3442
3460
|
"x-ves-example": "Troubleshoot site.",
|
|
3461
|
+
"x-f5xc-example": "Troubleshoot site",
|
|
3443
3462
|
"minLength": 0,
|
|
3444
3463
|
"maxLength": 1024,
|
|
3445
|
-
"x-
|
|
3464
|
+
"x-f5xc-required-for": {
|
|
3446
3465
|
"minimum_config": false,
|
|
3447
3466
|
"create": false,
|
|
3448
3467
|
"update": false,
|
|
@@ -3455,9 +3474,10 @@
|
|
|
3455
3474
|
"title": "Type",
|
|
3456
3475
|
"x-displayname": "Type",
|
|
3457
3476
|
"x-ves-example": "Technical Support.",
|
|
3477
|
+
"x-f5xc-example": "Technical Support",
|
|
3458
3478
|
"minLength": 0,
|
|
3459
3479
|
"maxLength": 1024,
|
|
3460
|
-
"x-
|
|
3480
|
+
"x-f5xc-required-for": {
|
|
3461
3481
|
"minimum_config": false,
|
|
3462
3482
|
"create": false,
|
|
3463
3483
|
"update": false,
|
|
@@ -3470,9 +3490,10 @@
|
|
|
3470
3490
|
"title": "Topic",
|
|
3471
3491
|
"x-displayname": "Topic",
|
|
3472
3492
|
"x-ves-example": "Troubleshooting.",
|
|
3493
|
+
"x-f5xc-example": "Troubleshooting",
|
|
3473
3494
|
"minLength": 0,
|
|
3474
3495
|
"maxLength": 1024,
|
|
3475
|
-
"x-
|
|
3496
|
+
"x-f5xc-required-for": {
|
|
3476
3497
|
"minimum_config": false,
|
|
3477
3498
|
"create": false,
|
|
3478
3499
|
"update": false,
|
|
@@ -3485,9 +3506,10 @@
|
|
|
3485
3506
|
"title": "Workspace",
|
|
3486
3507
|
"x-displayname": "Workspace",
|
|
3487
3508
|
"x-ves-example": "Multi-Cloud Network Connect.",
|
|
3509
|
+
"x-f5xc-example": "Multi-Cloud Network Connect",
|
|
3488
3510
|
"minLength": 0,
|
|
3489
3511
|
"maxLength": 1024,
|
|
3490
|
-
"x-
|
|
3512
|
+
"x-f5xc-required-for": {
|
|
3491
3513
|
"minimum_config": false,
|
|
3492
3514
|
"create": false,
|
|
3493
3515
|
"update": false,
|
|
@@ -3495,7 +3517,7 @@
|
|
|
3495
3517
|
}
|
|
3496
3518
|
}
|
|
3497
3519
|
},
|
|
3498
|
-
"x-
|
|
3520
|
+
"x-f5xc-minimum-configuration": {
|
|
3499
3521
|
"description": "Minimum configuration for commonOverlayData",
|
|
3500
3522
|
"required_fields": [
|
|
3501
3523
|
"priority",
|
|
@@ -3510,7 +3532,7 @@
|
|
|
3510
3532
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"priority\": \"value\",\n \"product_data\": \"value\",\n \"subject\": \"value\",\n \"support_type\": \"value\",\n \"topic\": \"value\"\n }\n}",
|
|
3511
3533
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_overlay_datas\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3512
3534
|
},
|
|
3513
|
-
"x-
|
|
3535
|
+
"x-f5xc-cli-domain": "other"
|
|
3514
3536
|
},
|
|
3515
3537
|
"commonStatusStyle": {
|
|
3516
3538
|
"type": "string",
|
|
@@ -3527,7 +3549,7 @@
|
|
|
3527
3549
|
"default": "STATUS_STYLE_UNKNOWN",
|
|
3528
3550
|
"x-displayname": "Status Style.",
|
|
3529
3551
|
"x-ves-proto-enum": "ves.io.schema.ai_assistant.common.StatusStyle",
|
|
3530
|
-
"x-
|
|
3552
|
+
"x-f5xc-minimum-configuration": {
|
|
3531
3553
|
"description": "Minimum configuration for commonStatusStyle",
|
|
3532
3554
|
"required_fields": [],
|
|
3533
3555
|
"mutually_exclusive_groups": [],
|
|
@@ -3535,7 +3557,7 @@
|
|
|
3535
3557
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
3536
3558
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_status_styles\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3537
3559
|
},
|
|
3538
|
-
"x-
|
|
3560
|
+
"x-f5xc-cli-domain": "other"
|
|
3539
3561
|
},
|
|
3540
3562
|
"commonWidgetType": {
|
|
3541
3563
|
"type": "string",
|
|
@@ -3553,7 +3575,7 @@
|
|
|
3553
3575
|
"default": "WIDGET_TYPE_NONE",
|
|
3554
3576
|
"x-displayname": "Widget Type.",
|
|
3555
3577
|
"x-ves-proto-enum": "ves.io.schema.ai_assistant.common.WidgetType",
|
|
3556
|
-
"x-
|
|
3578
|
+
"x-f5xc-minimum-configuration": {
|
|
3557
3579
|
"description": "Minimum configuration for commonWidgetType",
|
|
3558
3580
|
"required_fields": [],
|
|
3559
3581
|
"mutually_exclusive_groups": [],
|
|
@@ -3561,7 +3583,7 @@
|
|
|
3561
3583
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
3562
3584
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/common_widget_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3563
3585
|
},
|
|
3564
|
-
"x-
|
|
3586
|
+
"x-f5xc-cli-domain": "other"
|
|
3565
3587
|
},
|
|
3566
3588
|
"explain_log_recordAccuracy": {
|
|
3567
3589
|
"type": "string",
|
|
@@ -3576,7 +3598,7 @@
|
|
|
3576
3598
|
"default": "ACCURACY_NONE",
|
|
3577
3599
|
"x-displayname": "Accuracy",
|
|
3578
3600
|
"x-ves-proto-enum": "ves.io.schema.ai_assistant.explain_log_record.Accuracy",
|
|
3579
|
-
"x-
|
|
3601
|
+
"x-f5xc-minimum-configuration": {
|
|
3580
3602
|
"description": "Minimum configuration for explain_log_recordAccuracy",
|
|
3581
3603
|
"required_fields": [],
|
|
3582
3604
|
"mutually_exclusive_groups": [],
|
|
@@ -3584,7 +3606,7 @@
|
|
|
3584
3606
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
3585
3607
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/explain_log_record_accuracies\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3586
3608
|
},
|
|
3587
|
-
"x-
|
|
3609
|
+
"x-f5xc-cli-domain": "statistics"
|
|
3588
3610
|
},
|
|
3589
3611
|
"explain_log_recordBot": {
|
|
3590
3612
|
"type": "object",
|
|
@@ -3599,9 +3621,10 @@
|
|
|
3599
3621
|
"title": "Classification.",
|
|
3600
3622
|
"x-displayname": "Classification.",
|
|
3601
3623
|
"x-ves-example": "Suspicious.",
|
|
3624
|
+
"x-f5xc-example": "suspicious",
|
|
3602
3625
|
"minLength": 0,
|
|
3603
3626
|
"maxLength": 1024,
|
|
3604
|
-
"x-
|
|
3627
|
+
"x-f5xc-required-for": {
|
|
3605
3628
|
"minimum_config": false,
|
|
3606
3629
|
"create": false,
|
|
3607
3630
|
"update": false,
|
|
@@ -3614,9 +3637,10 @@
|
|
|
3614
3637
|
"title": "Name",
|
|
3615
3638
|
"x-displayname": "Name",
|
|
3616
3639
|
"x-ves-example": "Curl",
|
|
3640
|
+
"x-f5xc-example": "curl",
|
|
3617
3641
|
"minLength": 0,
|
|
3618
3642
|
"maxLength": 16,
|
|
3619
|
-
"x-
|
|
3643
|
+
"x-f5xc-required-for": {
|
|
3620
3644
|
"minimum_config": false,
|
|
3621
3645
|
"create": false,
|
|
3622
3646
|
"update": false,
|
|
@@ -3624,7 +3648,7 @@
|
|
|
3624
3648
|
},
|
|
3625
3649
|
"x-original-maxLength": 1024,
|
|
3626
3650
|
"x-reconciled-from-discovery": true,
|
|
3627
|
-
"x-reconciled-at": "2026-01-
|
|
3651
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169288+00:00"
|
|
3628
3652
|
},
|
|
3629
3653
|
"type": {
|
|
3630
3654
|
"type": "string",
|
|
@@ -3632,9 +3656,10 @@
|
|
|
3632
3656
|
"title": "Name",
|
|
3633
3657
|
"x-displayname": "Type",
|
|
3634
3658
|
"x-ves-example": "HTTP Library.",
|
|
3659
|
+
"x-f5xc-example": "HTTP Library",
|
|
3635
3660
|
"minLength": 0,
|
|
3636
3661
|
"maxLength": 1024,
|
|
3637
|
-
"x-
|
|
3662
|
+
"x-f5xc-required-for": {
|
|
3638
3663
|
"minimum_config": false,
|
|
3639
3664
|
"create": false,
|
|
3640
3665
|
"update": false,
|
|
@@ -3642,7 +3667,7 @@
|
|
|
3642
3667
|
}
|
|
3643
3668
|
}
|
|
3644
3669
|
},
|
|
3645
|
-
"x-
|
|
3670
|
+
"x-f5xc-minimum-configuration": {
|
|
3646
3671
|
"description": "Minimum configuration for explain_log_recordBot",
|
|
3647
3672
|
"required_fields": [
|
|
3648
3673
|
"classification",
|
|
@@ -3654,7 +3679,7 @@
|
|
|
3654
3679
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"classification\": \"value\",\n \"name\": \"value\",\n \"type\": \"value\"\n }\n}",
|
|
3655
3680
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/explain_log_record_bots\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3656
3681
|
},
|
|
3657
|
-
"x-
|
|
3682
|
+
"x-f5xc-cli-domain": "statistics"
|
|
3658
3683
|
},
|
|
3659
3684
|
"explain_log_recordBotDefenseEventDetails": {
|
|
3660
3685
|
"type": "object",
|
|
@@ -3672,9 +3697,10 @@
|
|
|
3672
3697
|
"title": "Automation_type.",
|
|
3673
3698
|
"x-displayname": "Automation type.",
|
|
3674
3699
|
"x-ves-example": "Token Missing.",
|
|
3700
|
+
"x-f5xc-example": "Token Missing",
|
|
3675
3701
|
"minLength": 0,
|
|
3676
3702
|
"maxLength": 1024,
|
|
3677
|
-
"x-
|
|
3703
|
+
"x-f5xc-required-for": {
|
|
3678
3704
|
"minimum_config": false,
|
|
3679
3705
|
"create": false,
|
|
3680
3706
|
"update": false,
|
|
@@ -3687,9 +3713,10 @@
|
|
|
3687
3713
|
"title": "Bot_type",
|
|
3688
3714
|
"x-displayname": "Bot type",
|
|
3689
3715
|
"x-ves-example": "MALICIOUS",
|
|
3716
|
+
"x-f5xc-example": "MALICIOUS",
|
|
3690
3717
|
"minLength": 0,
|
|
3691
3718
|
"maxLength": 1024,
|
|
3692
|
-
"x-
|
|
3719
|
+
"x-f5xc-required-for": {
|
|
3693
3720
|
"minimum_config": false,
|
|
3694
3721
|
"create": false,
|
|
3695
3722
|
"update": false,
|
|
@@ -3702,9 +3729,10 @@
|
|
|
3702
3729
|
"title": "Method",
|
|
3703
3730
|
"x-displayname": "Method",
|
|
3704
3731
|
"x-ves-example": "GET",
|
|
3732
|
+
"x-f5xc-example": "GET",
|
|
3705
3733
|
"minLength": 0,
|
|
3706
3734
|
"maxLength": 1024,
|
|
3707
|
-
"x-
|
|
3735
|
+
"x-f5xc-required-for": {
|
|
3708
3736
|
"minimum_config": false,
|
|
3709
3737
|
"create": false,
|
|
3710
3738
|
"update": false,
|
|
@@ -3717,9 +3745,10 @@
|
|
|
3717
3745
|
"title": "Request_path.",
|
|
3718
3746
|
"x-displayname": "Request Path.",
|
|
3719
3747
|
"x-ves-example": "/API/support/cases/case1.",
|
|
3748
|
+
"x-f5xc-example": "/api/support/cases/case1",
|
|
3720
3749
|
"minLength": 0,
|
|
3721
3750
|
"maxLength": 1024,
|
|
3722
|
-
"x-
|
|
3751
|
+
"x-f5xc-required-for": {
|
|
3723
3752
|
"minimum_config": false,
|
|
3724
3753
|
"create": false,
|
|
3725
3754
|
"update": false,
|
|
@@ -3727,7 +3756,7 @@
|
|
|
3727
3756
|
}
|
|
3728
3757
|
}
|
|
3729
3758
|
},
|
|
3730
|
-
"x-
|
|
3759
|
+
"x-f5xc-minimum-configuration": {
|
|
3731
3760
|
"description": "Minimum configuration for explain_log_recordBotDefenseEventDetails",
|
|
3732
3761
|
"required_fields": [
|
|
3733
3762
|
"action",
|
|
@@ -3741,7 +3770,7 @@
|
|
|
3741
3770
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"action\": \"value\",\n \"automation_type\": \"value\",\n \"bot_type\": \"value\",\n \"method\": \"value\",\n \"request_path\": \"value\"\n }\n}",
|
|
3742
3771
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/explain_log_record_bot_defense_event_detailses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3743
3772
|
},
|
|
3744
|
-
"x-
|
|
3773
|
+
"x-f5xc-cli-domain": "statistics"
|
|
3745
3774
|
},
|
|
3746
3775
|
"explain_log_recordEnforcementMode": {
|
|
3747
3776
|
"type": "string",
|
|
@@ -3755,7 +3784,7 @@
|
|
|
3755
3784
|
"default": "ENFORCEMENT_NONE",
|
|
3756
3785
|
"x-displayname": "Enforcement Mode.",
|
|
3757
3786
|
"x-ves-proto-enum": "ves.io.schema.ai_assistant.explain_log_record.EnforcementMode",
|
|
3758
|
-
"x-
|
|
3787
|
+
"x-f5xc-minimum-configuration": {
|
|
3759
3788
|
"description": "Minimum configuration for explain_log_recordEnforcementMode",
|
|
3760
3789
|
"required_fields": [],
|
|
3761
3790
|
"mutually_exclusive_groups": [],
|
|
@@ -3763,7 +3792,7 @@
|
|
|
3763
3792
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
3764
3793
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/explain_log_record_enforcement_modes\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3765
3794
|
},
|
|
3766
|
-
"x-
|
|
3795
|
+
"x-f5xc-cli-domain": "statistics"
|
|
3767
3796
|
},
|
|
3768
3797
|
"explain_log_recordExplainLogRecordResponse": {
|
|
3769
3798
|
"type": "object",
|
|
@@ -3779,9 +3808,10 @@
|
|
|
3779
3808
|
"title": "Actions",
|
|
3780
3809
|
"x-displayname": "Actions",
|
|
3781
3810
|
"x-ves-example": "If you think that this is a false positive you can create exclusion rule..",
|
|
3811
|
+
"x-f5xc-example": "If you think that this is a false positive you can create exclusion rule..",
|
|
3782
3812
|
"minLength": 0,
|
|
3783
3813
|
"maxLength": 1024,
|
|
3784
|
-
"x-
|
|
3814
|
+
"x-f5xc-required-for": {
|
|
3785
3815
|
"minimum_config": false,
|
|
3786
3816
|
"create": false,
|
|
3787
3817
|
"update": false,
|
|
@@ -3794,9 +3824,10 @@
|
|
|
3794
3824
|
"title": "Analysis",
|
|
3795
3825
|
"x-displayname": "Analysis",
|
|
3796
3826
|
"x-ves-example": "The request was blocked because Null in request violation was detected.",
|
|
3827
|
+
"x-f5xc-example": "The request was blocked because Null in request violation was detected",
|
|
3797
3828
|
"minLength": 0,
|
|
3798
3829
|
"maxLength": 1024,
|
|
3799
|
-
"x-
|
|
3830
|
+
"x-f5xc-required-for": {
|
|
3800
3831
|
"minimum_config": false,
|
|
3801
3832
|
"create": false,
|
|
3802
3833
|
"update": false,
|
|
@@ -3815,9 +3846,10 @@
|
|
|
3815
3846
|
"title": "Summary",
|
|
3816
3847
|
"x-displayname": "Summary",
|
|
3817
3848
|
"x-ves-example": "Request ID 12345 refers to a WAF security event for an HTTP request that was blocked.",
|
|
3849
|
+
"x-f5xc-example": "Request Id 12345 refers to a WAF security event for an HTTP request that was blocked",
|
|
3818
3850
|
"minLength": 0,
|
|
3819
3851
|
"maxLength": 1024,
|
|
3820
|
-
"x-
|
|
3852
|
+
"x-f5xc-required-for": {
|
|
3821
3853
|
"minimum_config": false,
|
|
3822
3854
|
"create": false,
|
|
3823
3855
|
"update": false,
|
|
@@ -3831,7 +3863,7 @@
|
|
|
3831
3863
|
"$ref": "#/components/schemas/explain_log_recordWAFEventDetails"
|
|
3832
3864
|
}
|
|
3833
3865
|
},
|
|
3834
|
-
"x-
|
|
3866
|
+
"x-f5xc-minimum-configuration": {
|
|
3835
3867
|
"description": "Minimum configuration for explain_log_recordExplainLogRecordResponse",
|
|
3836
3868
|
"required_fields": [
|
|
3837
3869
|
"actions",
|
|
@@ -3847,7 +3879,7 @@
|
|
|
3847
3879
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"actions\": \"value\",\n \"analysis\": \"value\",\n \"bot_defense_event_details\": \"value\",\n \"request_details\": \"value\",\n \"summary\": \"value\"\n }\n}",
|
|
3848
3880
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/explain_log_record_explain_log_record_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3849
3881
|
},
|
|
3850
|
-
"x-
|
|
3882
|
+
"x-f5xc-cli-domain": "statistics"
|
|
3851
3883
|
},
|
|
3852
3884
|
"explain_log_recordIPReputation": {
|
|
3853
3885
|
"type": "string",
|
|
@@ -3861,7 +3893,7 @@
|
|
|
3861
3893
|
"default": "IP_REPUTATION_NONE",
|
|
3862
3894
|
"x-displayname": "IP Reputation.",
|
|
3863
3895
|
"x-ves-proto-enum": "ves.io.schema.ai_assistant.explain_log_record.IPReputation",
|
|
3864
|
-
"x-
|
|
3896
|
+
"x-f5xc-minimum-configuration": {
|
|
3865
3897
|
"description": "Minimum configuration for explain_log_recordIPReputation",
|
|
3866
3898
|
"required_fields": [],
|
|
3867
3899
|
"mutually_exclusive_groups": [],
|
|
@@ -3869,7 +3901,7 @@
|
|
|
3869
3901
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
3870
3902
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/explain_log_record_i_p_reputations\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3871
3903
|
},
|
|
3872
|
-
"x-
|
|
3904
|
+
"x-f5xc-cli-domain": "statistics"
|
|
3873
3905
|
},
|
|
3874
3906
|
"explain_log_recordRequestDetails": {
|
|
3875
3907
|
"type": "object",
|
|
@@ -3884,9 +3916,10 @@
|
|
|
3884
3916
|
"title": "Domain",
|
|
3885
3917
|
"x-displayname": "Domain",
|
|
3886
3918
|
"x-ves-example": "example.com.",
|
|
3919
|
+
"x-f5xc-example": "example.com",
|
|
3887
3920
|
"minLength": 0,
|
|
3888
3921
|
"maxLength": 26,
|
|
3889
|
-
"x-
|
|
3922
|
+
"x-f5xc-required-for": {
|
|
3890
3923
|
"minimum_config": false,
|
|
3891
3924
|
"create": false,
|
|
3892
3925
|
"update": false,
|
|
@@ -3895,7 +3928,7 @@
|
|
|
3895
3928
|
"x-original-maxLength": 1024,
|
|
3896
3929
|
"format": "hostname",
|
|
3897
3930
|
"x-reconciled-from-discovery": true,
|
|
3898
|
-
"x-reconciled-at": "2026-01-
|
|
3931
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169312+00:00"
|
|
3899
3932
|
},
|
|
3900
3933
|
"rsp_code": {
|
|
3901
3934
|
"type": "integer",
|
|
@@ -3904,9 +3937,10 @@
|
|
|
3904
3937
|
"format": "int64",
|
|
3905
3938
|
"x-displayname": "Response Code.",
|
|
3906
3939
|
"x-ves-example": "200",
|
|
3940
|
+
"x-f5xc-example": "200",
|
|
3907
3941
|
"minimum": 0,
|
|
3908
3942
|
"maximum": 2147483647,
|
|
3909
|
-
"x-
|
|
3943
|
+
"x-f5xc-required-for": {
|
|
3910
3944
|
"minimum_config": false,
|
|
3911
3945
|
"create": false,
|
|
3912
3946
|
"update": false,
|
|
@@ -3919,9 +3953,10 @@
|
|
|
3919
3953
|
"title": "Rsp_code_details.",
|
|
3920
3954
|
"x-displayname": "Response Code Details.",
|
|
3921
3955
|
"x-ves-example": "Via upstream.",
|
|
3956
|
+
"x-f5xc-example": "via upstream",
|
|
3922
3957
|
"minLength": 0,
|
|
3923
3958
|
"maxLength": 1024,
|
|
3924
|
-
"x-
|
|
3959
|
+
"x-f5xc-required-for": {
|
|
3925
3960
|
"minimum_config": false,
|
|
3926
3961
|
"create": false,
|
|
3927
3962
|
"update": false,
|
|
@@ -3934,9 +3969,10 @@
|
|
|
3934
3969
|
"title": "Upstream_protocol_error_reason.",
|
|
3935
3970
|
"x-displayname": "Upstream Protocol Error Reason.",
|
|
3936
3971
|
"x-ves-example": "Headers_count_exceeds_limit.",
|
|
3972
|
+
"x-f5xc-example": "headers_count_exceeds_limit",
|
|
3937
3973
|
"minLength": 0,
|
|
3938
3974
|
"maxLength": 1024,
|
|
3939
|
-
"x-
|
|
3975
|
+
"x-f5xc-required-for": {
|
|
3940
3976
|
"minimum_config": false,
|
|
3941
3977
|
"create": false,
|
|
3942
3978
|
"update": false,
|
|
@@ -3944,7 +3980,7 @@
|
|
|
3944
3980
|
}
|
|
3945
3981
|
}
|
|
3946
3982
|
},
|
|
3947
|
-
"x-
|
|
3983
|
+
"x-f5xc-minimum-configuration": {
|
|
3948
3984
|
"description": "Minimum configuration for explain_log_recordRequestDetails",
|
|
3949
3985
|
"required_fields": [
|
|
3950
3986
|
"domain",
|
|
@@ -3957,7 +3993,7 @@
|
|
|
3957
3993
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"domain\": \"value\",\n \"rsp_code\": \"value\",\n \"rsp_code_details\": \"value\",\n \"upstream_protocol_error_reason\": \"value\"\n }\n}",
|
|
3958
3994
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/explain_log_record_request_detailses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3959
3995
|
},
|
|
3960
|
-
"x-
|
|
3996
|
+
"x-f5xc-cli-domain": "statistics"
|
|
3961
3997
|
},
|
|
3962
3998
|
"explain_log_recordSignature": {
|
|
3963
3999
|
"type": "object",
|
|
@@ -3975,9 +4011,10 @@
|
|
|
3975
4011
|
"title": "Attack_type.",
|
|
3976
4012
|
"x-displayname": "Attack Type.",
|
|
3977
4013
|
"x-ves-example": "Command Execution.",
|
|
4014
|
+
"x-f5xc-example": "Command Execution",
|
|
3978
4015
|
"minLength": 0,
|
|
3979
4016
|
"maxLength": 1024,
|
|
3980
|
-
"x-
|
|
4017
|
+
"x-f5xc-required-for": {
|
|
3981
4018
|
"minimum_config": false,
|
|
3982
4019
|
"create": false,
|
|
3983
4020
|
"update": false,
|
|
@@ -3990,9 +4027,10 @@
|
|
|
3990
4027
|
"title": "Context",
|
|
3991
4028
|
"x-displayname": "Context",
|
|
3992
4029
|
"x-ves-example": "Parameter",
|
|
4030
|
+
"x-f5xc-example": "parameter",
|
|
3993
4031
|
"minLength": 0,
|
|
3994
4032
|
"maxLength": 1024,
|
|
3995
|
-
"x-
|
|
4033
|
+
"x-f5xc-required-for": {
|
|
3996
4034
|
"minimum_config": false,
|
|
3997
4035
|
"create": false,
|
|
3998
4036
|
"update": false,
|
|
@@ -4005,11 +4043,12 @@
|
|
|
4005
4043
|
"title": "ID",
|
|
4006
4044
|
"x-displayname": "Signature ID.",
|
|
4007
4045
|
"x-ves-example": "200013569",
|
|
4046
|
+
"x-f5xc-example": "200013569",
|
|
4008
4047
|
"minimum": 1,
|
|
4009
4048
|
"maximum": 4094,
|
|
4010
4049
|
"minLength": 0,
|
|
4011
4050
|
"maxLength": 1024,
|
|
4012
|
-
"x-
|
|
4051
|
+
"x-f5xc-required-for": {
|
|
4013
4052
|
"minimum_config": false,
|
|
4014
4053
|
"create": false,
|
|
4015
4054
|
"update": false,
|
|
@@ -4022,9 +4061,10 @@
|
|
|
4022
4061
|
"title": "Matching_info.",
|
|
4023
4062
|
"x-displayname": "Matching Info.",
|
|
4024
4063
|
"x-ves-example": "Matched 7 chars on offset 6 against value: Token.",
|
|
4064
|
+
"x-f5xc-example": "Matched 7 chars on offset 6 against valueToken",
|
|
4025
4065
|
"minLength": 0,
|
|
4026
4066
|
"maxLength": 1024,
|
|
4027
|
-
"x-
|
|
4067
|
+
"x-f5xc-required-for": {
|
|
4028
4068
|
"minimum_config": false,
|
|
4029
4069
|
"create": false,
|
|
4030
4070
|
"update": false,
|
|
@@ -4037,9 +4077,10 @@
|
|
|
4037
4077
|
"title": "Name",
|
|
4038
4078
|
"x-displayname": "Name",
|
|
4039
4079
|
"x-ves-example": "Shell command processor.",
|
|
4080
|
+
"x-f5xc-example": "shell command processor",
|
|
4040
4081
|
"minLength": 0,
|
|
4041
4082
|
"maxLength": 16,
|
|
4042
|
-
"x-
|
|
4083
|
+
"x-f5xc-required-for": {
|
|
4043
4084
|
"minimum_config": false,
|
|
4044
4085
|
"create": false,
|
|
4045
4086
|
"update": false,
|
|
@@ -4047,7 +4088,7 @@
|
|
|
4047
4088
|
},
|
|
4048
4089
|
"x-original-maxLength": 1024,
|
|
4049
4090
|
"x-reconciled-from-discovery": true,
|
|
4050
|
-
"x-reconciled-at": "2026-01-
|
|
4091
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169329+00:00"
|
|
4051
4092
|
},
|
|
4052
4093
|
"state": {
|
|
4053
4094
|
"type": "string",
|
|
@@ -4055,9 +4096,10 @@
|
|
|
4055
4096
|
"title": "State",
|
|
4056
4097
|
"x-displayname": "State",
|
|
4057
4098
|
"x-ves-example": "Enabled",
|
|
4099
|
+
"x-f5xc-example": "Enabled",
|
|
4058
4100
|
"minLength": 0,
|
|
4059
4101
|
"maxLength": 1024,
|
|
4060
|
-
"x-
|
|
4102
|
+
"x-f5xc-required-for": {
|
|
4061
4103
|
"minimum_config": false,
|
|
4062
4104
|
"create": false,
|
|
4063
4105
|
"update": false,
|
|
@@ -4065,7 +4107,7 @@
|
|
|
4065
4107
|
}
|
|
4066
4108
|
}
|
|
4067
4109
|
},
|
|
4068
|
-
"x-
|
|
4110
|
+
"x-f5xc-minimum-configuration": {
|
|
4069
4111
|
"description": "Minimum configuration for explain_log_recordSignature",
|
|
4070
4112
|
"required_fields": [
|
|
4071
4113
|
"accuracy",
|
|
@@ -4081,7 +4123,7 @@
|
|
|
4081
4123
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"accuracy\": \"value\",\n \"attack_type\": \"value\",\n \"context\": \"value\",\n \"id\": \"value\",\n \"matching_info\": \"value\"\n }\n}",
|
|
4082
4124
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/explain_log_record_signatures\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4083
4125
|
},
|
|
4084
|
-
"x-
|
|
4126
|
+
"x-f5xc-cli-domain": "statistics"
|
|
4085
4127
|
},
|
|
4086
4128
|
"explain_log_recordSvcPolicyEventDetails": {
|
|
4087
4129
|
"type": "object",
|
|
@@ -4105,7 +4147,8 @@
|
|
|
4105
4147
|
},
|
|
4106
4148
|
"x-displayname": "IP threat categories.",
|
|
4107
4149
|
"x-ves-example": "SPAM_SOURCES,PHISHING.",
|
|
4108
|
-
"x-
|
|
4150
|
+
"x-f5xc-example": "SPAM_SOURCES,PHISHING",
|
|
4151
|
+
"x-f5xc-required-for": {
|
|
4109
4152
|
"minimum_config": false,
|
|
4110
4153
|
"create": false,
|
|
4111
4154
|
"update": false,
|
|
@@ -4121,9 +4164,10 @@
|
|
|
4121
4164
|
"title": "Policy",
|
|
4122
4165
|
"x-displayname": "Policy",
|
|
4123
4166
|
"x-ves-example": "Policy-1",
|
|
4167
|
+
"x-f5xc-example": "policy-1",
|
|
4124
4168
|
"minLength": 0,
|
|
4125
4169
|
"maxLength": 1024,
|
|
4126
|
-
"x-
|
|
4170
|
+
"x-f5xc-required-for": {
|
|
4127
4171
|
"minimum_config": false,
|
|
4128
4172
|
"create": false,
|
|
4129
4173
|
"update": false,
|
|
@@ -4136,9 +4180,10 @@
|
|
|
4136
4180
|
"title": "Policy namespace.",
|
|
4137
4181
|
"x-displayname": "Policy namespace.",
|
|
4138
4182
|
"x-ves-example": "Data-path",
|
|
4183
|
+
"x-f5xc-example": "data-path",
|
|
4139
4184
|
"minLength": 0,
|
|
4140
4185
|
"maxLength": 1024,
|
|
4141
|
-
"x-
|
|
4186
|
+
"x-f5xc-required-for": {
|
|
4142
4187
|
"minimum_config": false,
|
|
4143
4188
|
"create": false,
|
|
4144
4189
|
"update": false,
|
|
@@ -4151,9 +4196,10 @@
|
|
|
4151
4196
|
"title": "Policy rule.",
|
|
4152
4197
|
"x-displayname": "Policy rule.",
|
|
4153
4198
|
"x-ves-example": "Policy-rule-1.",
|
|
4199
|
+
"x-f5xc-example": "policy-rule-1",
|
|
4154
4200
|
"minLength": 0,
|
|
4155
4201
|
"maxLength": 1024,
|
|
4156
|
-
"x-
|
|
4202
|
+
"x-f5xc-required-for": {
|
|
4157
4203
|
"minimum_config": false,
|
|
4158
4204
|
"create": false,
|
|
4159
4205
|
"update": false,
|
|
@@ -4161,7 +4207,7 @@
|
|
|
4161
4207
|
}
|
|
4162
4208
|
}
|
|
4163
4209
|
},
|
|
4164
|
-
"x-
|
|
4210
|
+
"x-f5xc-minimum-configuration": {
|
|
4165
4211
|
"description": "Minimum configuration for explain_log_recordSvcPolicyEventDetails",
|
|
4166
4212
|
"required_fields": [
|
|
4167
4213
|
"action",
|
|
@@ -4177,7 +4223,7 @@
|
|
|
4177
4223
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"action\": \"value\",\n \"ip_risk\": \"value\",\n \"ip_threat_categories\": \"value\",\n \"ip_trustworthiness\": \"value\",\n \"policy\": \"value\"\n }\n}",
|
|
4178
4224
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/explain_log_record_svc_policy_event_detailses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4179
4225
|
},
|
|
4180
|
-
"x-
|
|
4226
|
+
"x-f5xc-cli-domain": "statistics"
|
|
4181
4227
|
},
|
|
4182
4228
|
"explain_log_recordThreatCampaign": {
|
|
4183
4229
|
"type": "object",
|
|
@@ -4192,9 +4238,10 @@
|
|
|
4192
4238
|
"title": "Attack_type.",
|
|
4193
4239
|
"x-displayname": "Attack Type.",
|
|
4194
4240
|
"x-ves-example": "Command Execution.",
|
|
4241
|
+
"x-f5xc-example": "Command Execution",
|
|
4195
4242
|
"minLength": 0,
|
|
4196
4243
|
"maxLength": 1024,
|
|
4197
|
-
"x-
|
|
4244
|
+
"x-f5xc-required-for": {
|
|
4198
4245
|
"minimum_config": false,
|
|
4199
4246
|
"create": false,
|
|
4200
4247
|
"update": false,
|
|
@@ -4207,11 +4254,12 @@
|
|
|
4207
4254
|
"title": "ID",
|
|
4208
4255
|
"x-displayname": "ThreatCampaign ID.",
|
|
4209
4256
|
"x-ves-example": "Cmpe1ab3d4feddb3c691bc68201d253be66.",
|
|
4257
|
+
"x-f5xc-example": "cmpe1ab3d4feddb3c691bc68201d253be66",
|
|
4210
4258
|
"minimum": 1,
|
|
4211
4259
|
"maximum": 4094,
|
|
4212
4260
|
"minLength": 0,
|
|
4213
4261
|
"maxLength": 1024,
|
|
4214
|
-
"x-
|
|
4262
|
+
"x-f5xc-required-for": {
|
|
4215
4263
|
"minimum_config": false,
|
|
4216
4264
|
"create": false,
|
|
4217
4265
|
"update": false,
|
|
@@ -4224,9 +4272,10 @@
|
|
|
4224
4272
|
"title": "Name",
|
|
4225
4273
|
"x-displayname": "Name",
|
|
4226
4274
|
"x-ves-example": "Nette Framework Remote Code Execution - oshi.",
|
|
4275
|
+
"x-f5xc-example": "Nette Framework Remote Code Execution - oshi",
|
|
4227
4276
|
"minLength": 0,
|
|
4228
4277
|
"maxLength": 16,
|
|
4229
|
-
"x-
|
|
4278
|
+
"x-f5xc-required-for": {
|
|
4230
4279
|
"minimum_config": false,
|
|
4231
4280
|
"create": false,
|
|
4232
4281
|
"update": false,
|
|
@@ -4234,10 +4283,10 @@
|
|
|
4234
4283
|
},
|
|
4235
4284
|
"x-original-maxLength": 1024,
|
|
4236
4285
|
"x-reconciled-from-discovery": true,
|
|
4237
|
-
"x-reconciled-at": "2026-01-
|
|
4286
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169347+00:00"
|
|
4238
4287
|
}
|
|
4239
4288
|
},
|
|
4240
|
-
"x-
|
|
4289
|
+
"x-f5xc-minimum-configuration": {
|
|
4241
4290
|
"description": "Minimum configuration for explain_log_recordThreatCampaign",
|
|
4242
4291
|
"required_fields": [
|
|
4243
4292
|
"attack_type",
|
|
@@ -4249,7 +4298,7 @@
|
|
|
4249
4298
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"attack_type\": \"value\",\n \"id\": \"value\",\n \"name\": \"value\"\n }\n}",
|
|
4250
4299
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/explain_log_record_threat_campaigns\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4251
4300
|
},
|
|
4252
|
-
"x-
|
|
4301
|
+
"x-f5xc-cli-domain": "statistics"
|
|
4253
4302
|
},
|
|
4254
4303
|
"explain_log_recordViolation": {
|
|
4255
4304
|
"type": "object",
|
|
@@ -4264,9 +4313,10 @@
|
|
|
4264
4313
|
"title": "Attack_type.",
|
|
4265
4314
|
"x-displayname": "Attack Type.",
|
|
4266
4315
|
"x-ves-example": "Command Execution.",
|
|
4316
|
+
"x-f5xc-example": "Command Execution",
|
|
4267
4317
|
"minLength": 0,
|
|
4268
4318
|
"maxLength": 1024,
|
|
4269
|
-
"x-
|
|
4319
|
+
"x-f5xc-required-for": {
|
|
4270
4320
|
"minimum_config": false,
|
|
4271
4321
|
"create": false,
|
|
4272
4322
|
"update": false,
|
|
@@ -4279,9 +4329,10 @@
|
|
|
4279
4329
|
"title": "Context",
|
|
4280
4330
|
"x-displayname": "Context",
|
|
4281
4331
|
"x-ves-example": "Parameter",
|
|
4332
|
+
"x-f5xc-example": "parameter",
|
|
4282
4333
|
"minLength": 0,
|
|
4283
4334
|
"maxLength": 1024,
|
|
4284
|
-
"x-
|
|
4335
|
+
"x-f5xc-required-for": {
|
|
4285
4336
|
"minimum_config": false,
|
|
4286
4337
|
"create": false,
|
|
4287
4338
|
"update": false,
|
|
@@ -4294,9 +4345,10 @@
|
|
|
4294
4345
|
"title": "Matching_info.",
|
|
4295
4346
|
"x-displayname": "Matching Info.",
|
|
4296
4347
|
"x-ves-example": "File extension was dat.",
|
|
4348
|
+
"x-f5xc-example": "File extension was dat",
|
|
4297
4349
|
"minLength": 0,
|
|
4298
4350
|
"maxLength": 1024,
|
|
4299
|
-
"x-
|
|
4351
|
+
"x-f5xc-required-for": {
|
|
4300
4352
|
"minimum_config": false,
|
|
4301
4353
|
"create": false,
|
|
4302
4354
|
"update": false,
|
|
@@ -4309,9 +4361,10 @@
|
|
|
4309
4361
|
"title": "Name",
|
|
4310
4362
|
"x-displayname": "Name",
|
|
4311
4363
|
"x-ves-example": "Illegal filetype.",
|
|
4364
|
+
"x-f5xc-example": "Illegal filetype",
|
|
4312
4365
|
"minLength": 0,
|
|
4313
4366
|
"maxLength": 16,
|
|
4314
|
-
"x-
|
|
4367
|
+
"x-f5xc-required-for": {
|
|
4315
4368
|
"minimum_config": false,
|
|
4316
4369
|
"create": false,
|
|
4317
4370
|
"update": false,
|
|
@@ -4319,7 +4372,7 @@
|
|
|
4319
4372
|
},
|
|
4320
4373
|
"x-original-maxLength": 1024,
|
|
4321
4374
|
"x-reconciled-from-discovery": true,
|
|
4322
|
-
"x-reconciled-at": "2026-01-
|
|
4375
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169356+00:00"
|
|
4323
4376
|
},
|
|
4324
4377
|
"state": {
|
|
4325
4378
|
"type": "string",
|
|
@@ -4327,9 +4380,10 @@
|
|
|
4327
4380
|
"title": "State",
|
|
4328
4381
|
"x-displayname": "State",
|
|
4329
4382
|
"x-ves-example": "Enabled",
|
|
4383
|
+
"x-f5xc-example": "Enabled",
|
|
4330
4384
|
"minLength": 0,
|
|
4331
4385
|
"maxLength": 1024,
|
|
4332
|
-
"x-
|
|
4386
|
+
"x-f5xc-required-for": {
|
|
4333
4387
|
"minimum_config": false,
|
|
4334
4388
|
"create": false,
|
|
4335
4389
|
"update": false,
|
|
@@ -4337,7 +4391,7 @@
|
|
|
4337
4391
|
}
|
|
4338
4392
|
}
|
|
4339
4393
|
},
|
|
4340
|
-
"x-
|
|
4394
|
+
"x-f5xc-minimum-configuration": {
|
|
4341
4395
|
"description": "Minimum configuration for explain_log_recordViolation",
|
|
4342
4396
|
"required_fields": [
|
|
4343
4397
|
"attack_type",
|
|
@@ -4351,7 +4405,7 @@
|
|
|
4351
4405
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"attack_type\": \"value\",\n \"context\": \"value\",\n \"matching_info\": \"value\",\n \"name\": \"value\",\n \"state\": \"value\"\n }\n}",
|
|
4352
4406
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/explain_log_record_violations\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4353
4407
|
},
|
|
4354
|
-
"x-
|
|
4408
|
+
"x-f5xc-cli-domain": "statistics"
|
|
4355
4409
|
},
|
|
4356
4410
|
"explain_log_recordWAFEventDetails": {
|
|
4357
4411
|
"type": "object",
|
|
@@ -4369,9 +4423,10 @@
|
|
|
4369
4423
|
"title": "App_firewall.",
|
|
4370
4424
|
"x-displayname": "App Firewall.",
|
|
4371
4425
|
"x-ves-example": "App-firewall.",
|
|
4426
|
+
"x-f5xc-example": "app-firewall",
|
|
4372
4427
|
"minLength": 0,
|
|
4373
4428
|
"maxLength": 1024,
|
|
4374
|
-
"x-
|
|
4429
|
+
"x-f5xc-required-for": {
|
|
4375
4430
|
"minimum_config": false,
|
|
4376
4431
|
"create": false,
|
|
4377
4432
|
"update": false,
|
|
@@ -4392,7 +4447,7 @@
|
|
|
4392
4447
|
"$ref": "#/components/schemas/explain_log_recordSignature"
|
|
4393
4448
|
},
|
|
4394
4449
|
"x-displayname": "Signatures.",
|
|
4395
|
-
"x-
|
|
4450
|
+
"x-f5xc-required-for": {
|
|
4396
4451
|
"minimum_config": false,
|
|
4397
4452
|
"create": false,
|
|
4398
4453
|
"update": false,
|
|
@@ -4407,7 +4462,7 @@
|
|
|
4407
4462
|
"$ref": "#/components/schemas/explain_log_recordThreatCampaign"
|
|
4408
4463
|
},
|
|
4409
4464
|
"x-displayname": "Threat Campaign.",
|
|
4410
|
-
"x-
|
|
4465
|
+
"x-f5xc-required-for": {
|
|
4411
4466
|
"minimum_config": false,
|
|
4412
4467
|
"create": false,
|
|
4413
4468
|
"update": false,
|
|
@@ -4422,7 +4477,7 @@
|
|
|
4422
4477
|
"$ref": "#/components/schemas/explain_log_recordViolation"
|
|
4423
4478
|
},
|
|
4424
4479
|
"x-displayname": "Violations.",
|
|
4425
|
-
"x-
|
|
4480
|
+
"x-f5xc-required-for": {
|
|
4426
4481
|
"minimum_config": false,
|
|
4427
4482
|
"create": false,
|
|
4428
4483
|
"update": false,
|
|
@@ -4430,7 +4485,7 @@
|
|
|
4430
4485
|
}
|
|
4431
4486
|
}
|
|
4432
4487
|
},
|
|
4433
|
-
"x-
|
|
4488
|
+
"x-f5xc-minimum-configuration": {
|
|
4434
4489
|
"description": "Minimum configuration for explain_log_recordWAFEventDetails",
|
|
4435
4490
|
"required_fields": [
|
|
4436
4491
|
"action",
|
|
@@ -4446,7 +4501,7 @@
|
|
|
4446
4501
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"action\": \"value\",\n \"app_firewall\": \"value\",\n \"bot\": \"value\",\n \"enforcement_mode\": \"value\",\n \"signatures\": \"value\"\n }\n}",
|
|
4447
4502
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/explain_log_record_w_a_f_event_detailses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4448
4503
|
},
|
|
4449
|
-
"x-
|
|
4504
|
+
"x-f5xc-cli-domain": "waf"
|
|
4450
4505
|
},
|
|
4451
4506
|
"gen_dashboard_filterGenDashboardFilterResponse": {
|
|
4452
4507
|
"type": "object",
|
|
@@ -4461,9 +4516,10 @@
|
|
|
4461
4516
|
"title": "Actions",
|
|
4462
4517
|
"x-displayname": "Actions",
|
|
4463
4518
|
"x-ves-example": "To view these events go to the ${{link:dashboard_link}} page.",
|
|
4519
|
+
"x-f5xc-example": "To view these events go to the ${{link:dashboard_link}} page",
|
|
4464
4520
|
"minLength": 0,
|
|
4465
4521
|
"maxLength": 1024,
|
|
4466
|
-
"x-
|
|
4522
|
+
"x-f5xc-required-for": {
|
|
4467
4523
|
"minimum_config": false,
|
|
4468
4524
|
"create": false,
|
|
4469
4525
|
"update": false,
|
|
@@ -4478,7 +4534,7 @@
|
|
|
4478
4534
|
"$ref": "#/components/schemas/commonLink"
|
|
4479
4535
|
},
|
|
4480
4536
|
"x-displayname": "Links",
|
|
4481
|
-
"x-
|
|
4537
|
+
"x-f5xc-required-for": {
|
|
4482
4538
|
"minimum_config": false,
|
|
4483
4539
|
"create": false,
|
|
4484
4540
|
"update": false,
|
|
@@ -4491,9 +4547,10 @@
|
|
|
4491
4547
|
"title": "Summary",
|
|
4492
4548
|
"x-displayname": "Summary",
|
|
4493
4549
|
"x-ves-example": "135 events matching your query were found.",
|
|
4550
|
+
"x-f5xc-example": "135 events matching your query were found",
|
|
4494
4551
|
"minLength": 0,
|
|
4495
4552
|
"maxLength": 1024,
|
|
4496
|
-
"x-
|
|
4553
|
+
"x-f5xc-required-for": {
|
|
4497
4554
|
"minimum_config": false,
|
|
4498
4555
|
"create": false,
|
|
4499
4556
|
"update": false,
|
|
@@ -4501,7 +4558,7 @@
|
|
|
4501
4558
|
}
|
|
4502
4559
|
}
|
|
4503
4560
|
},
|
|
4504
|
-
"x-
|
|
4561
|
+
"x-f5xc-minimum-configuration": {
|
|
4505
4562
|
"description": "Minimum configuration for gen_dashboard_filterGenDashboardFilterResponse",
|
|
4506
4563
|
"required_fields": [
|
|
4507
4564
|
"actions",
|
|
@@ -4513,7 +4570,7 @@
|
|
|
4513
4570
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"actions\": \"value\",\n \"links\": \"value\",\n \"summary\": \"value\"\n }\n}",
|
|
4514
4571
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/gen_dashboard_filter_gen_dashboard_filter_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4515
4572
|
},
|
|
4516
|
-
"x-
|
|
4573
|
+
"x-f5xc-cli-domain": "other"
|
|
4517
4574
|
},
|
|
4518
4575
|
"listItem": {
|
|
4519
4576
|
"type": "object",
|
|
@@ -4523,7 +4580,7 @@
|
|
|
4523
4580
|
"$ref": "#/components/schemas/commonLink"
|
|
4524
4581
|
}
|
|
4525
4582
|
},
|
|
4526
|
-
"x-
|
|
4583
|
+
"x-f5xc-minimum-configuration": {
|
|
4527
4584
|
"description": "Minimum configuration for listItem",
|
|
4528
4585
|
"required_fields": [
|
|
4529
4586
|
"link"
|
|
@@ -4533,7 +4590,7 @@
|
|
|
4533
4590
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"link\": \"value\"\n }\n}",
|
|
4534
4591
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/list_items\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4535
4592
|
},
|
|
4536
|
-
"x-
|
|
4593
|
+
"x-f5xc-cli-domain": "other"
|
|
4537
4594
|
},
|
|
4538
4595
|
"listList": {
|
|
4539
4596
|
"type": "object",
|
|
@@ -4548,7 +4605,8 @@
|
|
|
4548
4605
|
},
|
|
4549
4606
|
"x-displayname": "Item",
|
|
4550
4607
|
"x-ves-example": "Entries for each item.",
|
|
4551
|
-
"x-
|
|
4608
|
+
"x-f5xc-example": "Entries for each item",
|
|
4609
|
+
"x-f5xc-required-for": {
|
|
4552
4610
|
"minimum_config": false,
|
|
4553
4611
|
"create": false,
|
|
4554
4612
|
"update": false,
|
|
@@ -4557,7 +4615,7 @@
|
|
|
4557
4615
|
"maxLength": 26,
|
|
4558
4616
|
"minLength": 15,
|
|
4559
4617
|
"x-reconciled-from-discovery": true,
|
|
4560
|
-
"x-reconciled-at": "2026-01-
|
|
4618
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169378+00:00"
|
|
4561
4619
|
},
|
|
4562
4620
|
"title": {
|
|
4563
4621
|
"type": "string",
|
|
@@ -4565,9 +4623,10 @@
|
|
|
4565
4623
|
"title": "Title",
|
|
4566
4624
|
"x-displayname": "Title",
|
|
4567
4625
|
"x-ves-example": "Cloud Sites.",
|
|
4626
|
+
"x-f5xc-example": "Cloud Sites",
|
|
4568
4627
|
"minLength": 0,
|
|
4569
4628
|
"maxLength": 6,
|
|
4570
|
-
"x-
|
|
4629
|
+
"x-f5xc-required-for": {
|
|
4571
4630
|
"minimum_config": false,
|
|
4572
4631
|
"create": false,
|
|
4573
4632
|
"update": false,
|
|
@@ -4575,10 +4634,10 @@
|
|
|
4575
4634
|
},
|
|
4576
4635
|
"x-original-maxLength": 1024,
|
|
4577
4636
|
"x-reconciled-from-discovery": true,
|
|
4578
|
-
"x-reconciled-at": "2026-01-
|
|
4637
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169383+00:00"
|
|
4579
4638
|
}
|
|
4580
4639
|
},
|
|
4581
|
-
"x-
|
|
4640
|
+
"x-f5xc-minimum-configuration": {
|
|
4582
4641
|
"description": "Minimum configuration for listList",
|
|
4583
4642
|
"required_fields": [
|
|
4584
4643
|
"item",
|
|
@@ -4589,7 +4648,7 @@
|
|
|
4589
4648
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"item\": \"value\",\n \"title\": \"value\"\n }\n}",
|
|
4590
4649
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/list_lists\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4591
4650
|
},
|
|
4592
|
-
"x-
|
|
4651
|
+
"x-f5xc-cli-domain": "other"
|
|
4593
4652
|
},
|
|
4594
4653
|
"listListResponse": {
|
|
4595
4654
|
"type": "object",
|
|
@@ -4614,9 +4673,7 @@
|
|
|
4614
4673
|
"ves.io.schema.rules.repeated.unique": "true",
|
|
4615
4674
|
"ves.io.schema.rules.string.max_len": "6"
|
|
4616
4675
|
},
|
|
4617
|
-
"
|
|
4618
|
-
"ves.io.schema.rules.string.max_len": "6",
|
|
4619
|
-
"x-ves-required-for": {
|
|
4676
|
+
"x-f5xc-required-for": {
|
|
4620
4677
|
"minimum_config": false,
|
|
4621
4678
|
"create": false,
|
|
4622
4679
|
"update": false,
|
|
@@ -4631,7 +4688,7 @@
|
|
|
4631
4688
|
"$ref": "#/components/schemas/listList"
|
|
4632
4689
|
},
|
|
4633
4690
|
"x-displayname": "List View",
|
|
4634
|
-
"x-
|
|
4691
|
+
"x-f5xc-required-for": {
|
|
4635
4692
|
"minimum_config": false,
|
|
4636
4693
|
"create": false,
|
|
4637
4694
|
"update": false,
|
|
@@ -4644,9 +4701,10 @@
|
|
|
4644
4701
|
"title": "Summary",
|
|
4645
4702
|
"x-displayname": "Summary",
|
|
4646
4703
|
"x-ves-example": "This is summary of List response.",
|
|
4704
|
+
"x-f5xc-example": "This is summary of List response",
|
|
4647
4705
|
"minLength": 0,
|
|
4648
4706
|
"maxLength": 1024,
|
|
4649
|
-
"x-
|
|
4707
|
+
"x-f5xc-required-for": {
|
|
4650
4708
|
"minimum_config": false,
|
|
4651
4709
|
"create": false,
|
|
4652
4710
|
"update": false,
|
|
@@ -4654,7 +4712,7 @@
|
|
|
4654
4712
|
}
|
|
4655
4713
|
}
|
|
4656
4714
|
},
|
|
4657
|
-
"x-
|
|
4715
|
+
"x-f5xc-minimum-configuration": {
|
|
4658
4716
|
"description": "Minimum configuration for listListResponse",
|
|
4659
4717
|
"required_fields": [
|
|
4660
4718
|
"external_links",
|
|
@@ -4666,7 +4724,7 @@
|
|
|
4666
4724
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"external_links\": \"value\",\n \"items\": \"value\",\n \"summary\": \"value\"\n }\n}",
|
|
4667
4725
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/list_list_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4668
4726
|
},
|
|
4669
|
-
"x-
|
|
4727
|
+
"x-f5xc-cli-domain": "other"
|
|
4670
4728
|
},
|
|
4671
4729
|
"policyIPThreatCategory": {
|
|
4672
4730
|
"type": "string",
|
|
@@ -4689,7 +4747,7 @@
|
|
|
4689
4747
|
"default": "SPAM_SOURCES",
|
|
4690
4748
|
"x-displayname": "IP Threat Category.",
|
|
4691
4749
|
"x-ves-proto-enum": "ves.io.schema.policy.IPThreatCategory",
|
|
4692
|
-
"x-
|
|
4750
|
+
"x-f5xc-minimum-configuration": {
|
|
4693
4751
|
"description": "Minimum configuration for policyIPThreatCategory",
|
|
4694
4752
|
"required_fields": [],
|
|
4695
4753
|
"mutually_exclusive_groups": [],
|
|
@@ -4697,7 +4755,7 @@
|
|
|
4697
4755
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
4698
4756
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/policy_i_p_threat_categories\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4699
4757
|
},
|
|
4700
|
-
"x-
|
|
4758
|
+
"x-f5xc-cli-domain": "other"
|
|
4701
4759
|
},
|
|
4702
4760
|
"protobufAny": {
|
|
4703
4761
|
"type": "object",
|
|
@@ -4708,7 +4766,7 @@
|
|
|
4708
4766
|
"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.",
|
|
4709
4767
|
"minLength": 0,
|
|
4710
4768
|
"maxLength": 1024,
|
|
4711
|
-
"x-
|
|
4769
|
+
"x-f5xc-required-for": {
|
|
4712
4770
|
"minimum_config": false,
|
|
4713
4771
|
"create": false,
|
|
4714
4772
|
"update": false,
|
|
@@ -4721,7 +4779,7 @@
|
|
|
4721
4779
|
"format": "byte",
|
|
4722
4780
|
"minLength": 0,
|
|
4723
4781
|
"maxLength": 15,
|
|
4724
|
-
"x-
|
|
4782
|
+
"x-f5xc-required-for": {
|
|
4725
4783
|
"minimum_config": false,
|
|
4726
4784
|
"create": false,
|
|
4727
4785
|
"update": false,
|
|
@@ -4729,10 +4787,10 @@
|
|
|
4729
4787
|
},
|
|
4730
4788
|
"x-original-maxLength": 1024,
|
|
4731
4789
|
"x-reconciled-from-discovery": true,
|
|
4732
|
-
"x-reconciled-at": "2026-01-
|
|
4790
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169394+00:00"
|
|
4733
4791
|
}
|
|
4734
4792
|
},
|
|
4735
|
-
"x-
|
|
4793
|
+
"x-f5xc-minimum-configuration": {
|
|
4736
4794
|
"description": "Minimum configuration for protobufAny",
|
|
4737
4795
|
"required_fields": [
|
|
4738
4796
|
"type_url",
|
|
@@ -4743,7 +4801,7 @@
|
|
|
4743
4801
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"type_url\": \"value\",\n \"value\": \"value\"\n }\n}",
|
|
4744
4802
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/protobuf_anies\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4745
4803
|
},
|
|
4746
|
-
"x-
|
|
4804
|
+
"x-f5xc-cli-domain": "other"
|
|
4747
4805
|
},
|
|
4748
4806
|
"schemaEmpty": {
|
|
4749
4807
|
"type": "object",
|
|
@@ -4751,7 +4809,7 @@
|
|
|
4751
4809
|
"title": "Empty",
|
|
4752
4810
|
"x-displayname": "Empty",
|
|
4753
4811
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
4754
|
-
"x-
|
|
4812
|
+
"x-f5xc-minimum-configuration": {
|
|
4755
4813
|
"description": "Minimum configuration for schemaEmpty",
|
|
4756
4814
|
"required_fields": [],
|
|
4757
4815
|
"mutually_exclusive_groups": [],
|
|
@@ -4759,7 +4817,7 @@
|
|
|
4759
4817
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
4760
4818
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/schema_empties\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4761
4819
|
},
|
|
4762
|
-
"x-
|
|
4820
|
+
"x-f5xc-cli-domain": "other"
|
|
4763
4821
|
},
|
|
4764
4822
|
"schemaErrorCode": {
|
|
4765
4823
|
"type": "string",
|
|
@@ -4779,7 +4837,7 @@
|
|
|
4779
4837
|
"default": "EOK",
|
|
4780
4838
|
"x-displayname": "Error Code.",
|
|
4781
4839
|
"x-ves-proto-enum": "ves.io.schema.ErrorCode",
|
|
4782
|
-
"x-
|
|
4840
|
+
"x-f5xc-minimum-configuration": {
|
|
4783
4841
|
"description": "Minimum configuration for schemaErrorCode",
|
|
4784
4842
|
"required_fields": [],
|
|
4785
4843
|
"mutually_exclusive_groups": [],
|
|
@@ -4787,7 +4845,7 @@
|
|
|
4787
4845
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
4788
4846
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/schema_error_codes\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4789
4847
|
},
|
|
4790
|
-
"x-
|
|
4848
|
+
"x-f5xc-cli-domain": "other"
|
|
4791
4849
|
},
|
|
4792
4850
|
"schemaErrorType": {
|
|
4793
4851
|
"type": "object",
|
|
@@ -4808,9 +4866,10 @@
|
|
|
4808
4866
|
"title": "Message",
|
|
4809
4867
|
"x-displayname": "Message",
|
|
4810
4868
|
"x-ves-example": "Value",
|
|
4869
|
+
"x-f5xc-example": "value",
|
|
4811
4870
|
"minLength": 0,
|
|
4812
4871
|
"maxLength": 1024,
|
|
4813
|
-
"x-
|
|
4872
|
+
"x-f5xc-required-for": {
|
|
4814
4873
|
"minimum_config": false,
|
|
4815
4874
|
"create": false,
|
|
4816
4875
|
"update": false,
|
|
@@ -4818,7 +4877,7 @@
|
|
|
4818
4877
|
}
|
|
4819
4878
|
}
|
|
4820
4879
|
},
|
|
4821
|
-
"x-
|
|
4880
|
+
"x-f5xc-minimum-configuration": {
|
|
4822
4881
|
"description": "Minimum configuration for schemaErrorType",
|
|
4823
4882
|
"required_fields": [
|
|
4824
4883
|
"code",
|
|
@@ -4830,7 +4889,7 @@
|
|
|
4830
4889
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"code\": \"value\",\n \"error_obj\": \"value\",\n \"message\": \"value\"\n }\n}",
|
|
4831
4890
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/schema_error_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4832
4891
|
},
|
|
4833
|
-
"x-
|
|
4892
|
+
"x-f5xc-cli-domain": "other"
|
|
4834
4893
|
},
|
|
4835
4894
|
"site_analysisSiteAnalysisResponse": {
|
|
4836
4895
|
"type": "object",
|
|
@@ -4855,9 +4914,7 @@
|
|
|
4855
4914
|
"ves.io.schema.rules.repeated.unique": "true",
|
|
4856
4915
|
"ves.io.schema.rules.string.max_len": "6"
|
|
4857
4916
|
},
|
|
4858
|
-
"
|
|
4859
|
-
"ves.io.schema.rules.string.max_len": "6",
|
|
4860
|
-
"x-ves-required-for": {
|
|
4917
|
+
"x-f5xc-required-for": {
|
|
4861
4918
|
"minimum_config": false,
|
|
4862
4919
|
"create": false,
|
|
4863
4920
|
"update": false,
|
|
@@ -4880,9 +4937,7 @@
|
|
|
4880
4937
|
"ves.io.schema.rules.repeated.unique": "true",
|
|
4881
4938
|
"ves.io.schema.rules.string.max_len": "6"
|
|
4882
4939
|
},
|
|
4883
|
-
"
|
|
4884
|
-
"ves.io.schema.rules.string.max_len": "6",
|
|
4885
|
-
"x-ves-required-for": {
|
|
4940
|
+
"x-f5xc-required-for": {
|
|
4886
4941
|
"minimum_config": false,
|
|
4887
4942
|
"create": false,
|
|
4888
4943
|
"update": false,
|
|
@@ -4898,9 +4953,10 @@
|
|
|
4898
4953
|
"title": "Summary",
|
|
4899
4954
|
"x-displayname": "Summary",
|
|
4900
4955
|
"x-ves-example": "This site analysis response provides status of sites.",
|
|
4956
|
+
"x-f5xc-example": "This site analysis response provides status of sites.",
|
|
4901
4957
|
"minLength": 0,
|
|
4902
4958
|
"maxLength": 1024,
|
|
4903
|
-
"x-
|
|
4959
|
+
"x-f5xc-required-for": {
|
|
4904
4960
|
"minimum_config": false,
|
|
4905
4961
|
"create": false,
|
|
4906
4962
|
"update": false,
|
|
@@ -4911,7 +4967,7 @@
|
|
|
4911
4967
|
"$ref": "#/components/schemas/widgetWidgetView"
|
|
4912
4968
|
}
|
|
4913
4969
|
},
|
|
4914
|
-
"x-
|
|
4970
|
+
"x-f5xc-minimum-configuration": {
|
|
4915
4971
|
"description": "Minimum configuration for site_analysisSiteAnalysisResponse",
|
|
4916
4972
|
"required_fields": [
|
|
4917
4973
|
"external_links",
|
|
@@ -4925,7 +4981,7 @@
|
|
|
4925
4981
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"external_links\": \"value\",\n \"internal_links\": \"value\",\n \"overlay_content\": \"value\",\n \"summary\": \"value\",\n \"table_view\": \"value\"\n }\n}",
|
|
4926
4982
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/site_analysis_site_analysis_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4927
4983
|
},
|
|
4928
|
-
"x-
|
|
4984
|
+
"x-f5xc-cli-domain": "other"
|
|
4929
4985
|
},
|
|
4930
4986
|
"widgetCell": {
|
|
4931
4987
|
"type": "object",
|
|
@@ -4943,9 +4999,10 @@
|
|
|
4943
4999
|
"title": "Value",
|
|
4944
5000
|
"x-displayname": "Value",
|
|
4945
5001
|
"x-ves-example": "Site1",
|
|
5002
|
+
"x-f5xc-example": "site1",
|
|
4946
5003
|
"minLength": 0,
|
|
4947
5004
|
"maxLength": 15,
|
|
4948
|
-
"x-
|
|
5005
|
+
"x-f5xc-required-for": {
|
|
4949
5006
|
"minimum_config": false,
|
|
4950
5007
|
"create": false,
|
|
4951
5008
|
"update": false,
|
|
@@ -4953,10 +5010,10 @@
|
|
|
4953
5010
|
},
|
|
4954
5011
|
"x-original-maxLength": 1024,
|
|
4955
5012
|
"x-reconciled-from-discovery": true,
|
|
4956
|
-
"x-reconciled-at": "2026-01-
|
|
5013
|
+
"x-reconciled-at": "2026-01-04T19:54:23.169414+00:00"
|
|
4957
5014
|
}
|
|
4958
5015
|
},
|
|
4959
|
-
"x-
|
|
5016
|
+
"x-f5xc-minimum-configuration": {
|
|
4960
5017
|
"description": "Minimum configuration for widgetCell",
|
|
4961
5018
|
"required_fields": [
|
|
4962
5019
|
"link",
|
|
@@ -4968,7 +5025,7 @@
|
|
|
4968
5025
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"link\": \"value\",\n \"properties\": \"value\",\n \"value\": \"value\"\n }\n}",
|
|
4969
5026
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/widget_cells\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4970
5027
|
},
|
|
4971
|
-
"x-
|
|
5028
|
+
"x-f5xc-cli-domain": "other"
|
|
4972
5029
|
},
|
|
4973
5030
|
"widgetRow": {
|
|
4974
5031
|
"type": "object",
|
|
@@ -4986,7 +5043,8 @@
|
|
|
4986
5043
|
},
|
|
4987
5044
|
"x-displayname": "Values",
|
|
4988
5045
|
"x-ves-example": "Site Name:\"site-1.",
|
|
4989
|
-
"x-
|
|
5046
|
+
"x-f5xc-example": "\"Site Name:\"site-1\"",
|
|
5047
|
+
"x-f5xc-required-for": {
|
|
4990
5048
|
"minimum_config": false,
|
|
4991
5049
|
"create": false,
|
|
4992
5050
|
"update": false,
|
|
@@ -4994,7 +5052,7 @@
|
|
|
4994
5052
|
}
|
|
4995
5053
|
}
|
|
4996
5054
|
},
|
|
4997
|
-
"x-
|
|
5055
|
+
"x-f5xc-minimum-configuration": {
|
|
4998
5056
|
"description": "Minimum configuration for widgetRow",
|
|
4999
5057
|
"required_fields": [
|
|
5000
5058
|
"cells"
|
|
@@ -5004,7 +5062,7 @@
|
|
|
5004
5062
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"cells\": \"value\"\n }\n}",
|
|
5005
5063
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/widget_rows\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5006
5064
|
},
|
|
5007
|
-
"x-
|
|
5065
|
+
"x-f5xc-cli-domain": "other"
|
|
5008
5066
|
},
|
|
5009
5067
|
"widgetTable": {
|
|
5010
5068
|
"type": "object",
|
|
@@ -5024,8 +5082,7 @@
|
|
|
5024
5082
|
"x-validation-rules": {
|
|
5025
5083
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
5026
5084
|
},
|
|
5027
|
-
"
|
|
5028
|
-
"x-ves-required-for": {
|
|
5085
|
+
"x-f5xc-required-for": {
|
|
5029
5086
|
"minimum_config": false,
|
|
5030
5087
|
"create": false,
|
|
5031
5088
|
"update": false,
|
|
@@ -5041,7 +5098,8 @@
|
|
|
5041
5098
|
},
|
|
5042
5099
|
"x-displayname": "Row",
|
|
5043
5100
|
"x-ves-example": "Entries for each rows.",
|
|
5044
|
-
"x-
|
|
5101
|
+
"x-f5xc-example": "Entries for each rows",
|
|
5102
|
+
"x-f5xc-required-for": {
|
|
5045
5103
|
"minimum_config": false,
|
|
5046
5104
|
"create": false,
|
|
5047
5105
|
"update": false,
|
|
@@ -5052,7 +5110,7 @@
|
|
|
5052
5110
|
"$ref": "#/components/schemas/commonWidgetType"
|
|
5053
5111
|
}
|
|
5054
5112
|
},
|
|
5055
|
-
"x-
|
|
5113
|
+
"x-f5xc-minimum-configuration": {
|
|
5056
5114
|
"description": "Minimum configuration for widgetTable",
|
|
5057
5115
|
"required_fields": [
|
|
5058
5116
|
"field_properties",
|
|
@@ -5064,7 +5122,7 @@
|
|
|
5064
5122
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"field_properties\": \"value\",\n \"rows\": \"value\",\n \"widget_type\": \"value\"\n }\n}",
|
|
5065
5123
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/widget_tables\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5066
5124
|
},
|
|
5067
|
-
"x-
|
|
5125
|
+
"x-f5xc-cli-domain": "other"
|
|
5068
5126
|
},
|
|
5069
5127
|
"widgetWidgetResponse": {
|
|
5070
5128
|
"type": "object",
|
|
@@ -5081,7 +5139,7 @@
|
|
|
5081
5139
|
"$ref": "#/components/schemas/commonLink"
|
|
5082
5140
|
},
|
|
5083
5141
|
"x-displayname": "Links",
|
|
5084
|
-
"x-
|
|
5142
|
+
"x-f5xc-required-for": {
|
|
5085
5143
|
"minimum_config": false,
|
|
5086
5144
|
"create": false,
|
|
5087
5145
|
"update": false,
|
|
@@ -5096,7 +5154,7 @@
|
|
|
5096
5154
|
"$ref": "#/components/schemas/widgetWidgetView"
|
|
5097
5155
|
},
|
|
5098
5156
|
"x-displayname": "Widget View.",
|
|
5099
|
-
"x-
|
|
5157
|
+
"x-f5xc-required-for": {
|
|
5100
5158
|
"minimum_config": false,
|
|
5101
5159
|
"create": false,
|
|
5102
5160
|
"update": false,
|
|
@@ -5109,9 +5167,10 @@
|
|
|
5109
5167
|
"title": "Summary",
|
|
5110
5168
|
"x-displayname": "Summary",
|
|
5111
5169
|
"x-ves-example": "This is summary of widget response.",
|
|
5170
|
+
"x-f5xc-example": "This is summary of widget response",
|
|
5112
5171
|
"minLength": 0,
|
|
5113
5172
|
"maxLength": 1024,
|
|
5114
|
-
"x-
|
|
5173
|
+
"x-f5xc-required-for": {
|
|
5115
5174
|
"minimum_config": false,
|
|
5116
5175
|
"create": false,
|
|
5117
5176
|
"update": false,
|
|
@@ -5119,7 +5178,7 @@
|
|
|
5119
5178
|
}
|
|
5120
5179
|
}
|
|
5121
5180
|
},
|
|
5122
|
-
"x-
|
|
5181
|
+
"x-f5xc-minimum-configuration": {
|
|
5123
5182
|
"description": "Minimum configuration for widgetWidgetResponse",
|
|
5124
5183
|
"required_fields": [
|
|
5125
5184
|
"item_links",
|
|
@@ -5131,7 +5190,7 @@
|
|
|
5131
5190
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"item_links\": \"value\",\n \"items\": \"value\",\n \"summary\": \"value\"\n }\n}",
|
|
5132
5191
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/widget_widget_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5133
5192
|
},
|
|
5134
|
-
"x-
|
|
5193
|
+
"x-f5xc-cli-domain": "other"
|
|
5135
5194
|
},
|
|
5136
5195
|
"widgetWidgetView": {
|
|
5137
5196
|
"type": "object",
|
|
@@ -5141,7 +5200,7 @@
|
|
|
5141
5200
|
"$ref": "#/components/schemas/widgetTable"
|
|
5142
5201
|
}
|
|
5143
5202
|
},
|
|
5144
|
-
"x-
|
|
5203
|
+
"x-f5xc-minimum-configuration": {
|
|
5145
5204
|
"description": "Minimum configuration for widgetWidgetView",
|
|
5146
5205
|
"required_fields": [
|
|
5147
5206
|
"item"
|
|
@@ -5151,7 +5210,7 @@
|
|
|
5151
5210
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"item\": \"value\"\n }\n}",
|
|
5152
5211
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/widget_widget_views\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5153
5212
|
},
|
|
5154
|
-
"x-
|
|
5213
|
+
"x-f5xc-cli-domain": "other"
|
|
5155
5214
|
},
|
|
5156
5215
|
"bfdpEnableFeatureRequest": {
|
|
5157
5216
|
"type": "object",
|
|
@@ -5159,7 +5218,7 @@
|
|
|
5159
5218
|
"title": "EnableFeatureRequest.",
|
|
5160
5219
|
"x-displayname": "EnableFeature Request.",
|
|
5161
5220
|
"x-ves-proto-message": "ves.io.schema.ai_data.bfdp.EnableFeatureRequest",
|
|
5162
|
-
"x-
|
|
5221
|
+
"x-f5xc-minimum-configuration": {
|
|
5163
5222
|
"description": "Minimum configuration for bfdpEnableFeatureRequest",
|
|
5164
5223
|
"required_fields": [],
|
|
5165
5224
|
"mutually_exclusive_groups": [],
|
|
@@ -5167,7 +5226,7 @@
|
|
|
5167
5226
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
5168
5227
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/bfdp_enable_feature_requests\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5169
5228
|
},
|
|
5170
|
-
"x-
|
|
5229
|
+
"x-f5xc-cli-domain": "other"
|
|
5171
5230
|
},
|
|
5172
5231
|
"bfdpEnableFeatureResponse": {
|
|
5173
5232
|
"type": "object",
|
|
@@ -5175,7 +5234,7 @@
|
|
|
5175
5234
|
"title": "EnableFeatureResponse.",
|
|
5176
5235
|
"x-displayname": "EnableFeature Response.",
|
|
5177
5236
|
"x-ves-proto-message": "ves.io.schema.ai_data.bfdp.EnableFeatureResponse",
|
|
5178
|
-
"x-
|
|
5237
|
+
"x-f5xc-minimum-configuration": {
|
|
5179
5238
|
"description": "Minimum configuration for bfdpEnableFeatureResponse",
|
|
5180
5239
|
"required_fields": [],
|
|
5181
5240
|
"mutually_exclusive_groups": [],
|
|
@@ -5183,7 +5242,7 @@
|
|
|
5183
5242
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
5184
5243
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/bfdp_enable_feature_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5185
5244
|
},
|
|
5186
|
-
"x-
|
|
5245
|
+
"x-f5xc-cli-domain": "other"
|
|
5187
5246
|
},
|
|
5188
5247
|
"bfdpRefreshTokenRequest": {
|
|
5189
5248
|
"type": "object",
|
|
@@ -5198,9 +5257,10 @@
|
|
|
5198
5257
|
"title": "Product_name.",
|
|
5199
5258
|
"x-displayname": "Product_name.",
|
|
5200
5259
|
"x-ves-example": "Product_name.",
|
|
5260
|
+
"x-f5xc-example": "product_name",
|
|
5201
5261
|
"minLength": 0,
|
|
5202
5262
|
"maxLength": 1024,
|
|
5203
|
-
"x-
|
|
5263
|
+
"x-f5xc-required-for": {
|
|
5204
5264
|
"minimum_config": false,
|
|
5205
5265
|
"create": false,
|
|
5206
5266
|
"update": false,
|
|
@@ -5208,7 +5268,7 @@
|
|
|
5208
5268
|
}
|
|
5209
5269
|
}
|
|
5210
5270
|
},
|
|
5211
|
-
"x-
|
|
5271
|
+
"x-f5xc-minimum-configuration": {
|
|
5212
5272
|
"description": "Minimum configuration for bfdpRefreshTokenRequest",
|
|
5213
5273
|
"required_fields": [
|
|
5214
5274
|
"product_name"
|
|
@@ -5218,7 +5278,7 @@
|
|
|
5218
5278
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"product_name\": \"value\"\n }\n}",
|
|
5219
5279
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/bfdp_refresh_token_requests\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5220
5280
|
},
|
|
5221
|
-
"x-
|
|
5281
|
+
"x-f5xc-cli-domain": "users"
|
|
5222
5282
|
},
|
|
5223
5283
|
"bfdpRefreshTokenResponse": {
|
|
5224
5284
|
"type": "object",
|
|
@@ -5233,9 +5293,10 @@
|
|
|
5233
5293
|
"title": "Result",
|
|
5234
5294
|
"x-displayname": "Result",
|
|
5235
5295
|
"x-ves-example": "Result",
|
|
5296
|
+
"x-f5xc-example": "result",
|
|
5236
5297
|
"minLength": 0,
|
|
5237
5298
|
"maxLength": 1024,
|
|
5238
|
-
"x-
|
|
5299
|
+
"x-f5xc-required-for": {
|
|
5239
5300
|
"minimum_config": false,
|
|
5240
5301
|
"create": false,
|
|
5241
5302
|
"update": false,
|
|
@@ -5243,7 +5304,7 @@
|
|
|
5243
5304
|
}
|
|
5244
5305
|
}
|
|
5245
5306
|
},
|
|
5246
|
-
"x-
|
|
5307
|
+
"x-f5xc-minimum-configuration": {
|
|
5247
5308
|
"description": "Minimum configuration for bfdpRefreshTokenResponse",
|
|
5248
5309
|
"required_fields": [
|
|
5249
5310
|
"result"
|
|
@@ -5253,7 +5314,7 @@
|
|
|
5253
5314
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"result\": \"value\"\n }\n}",
|
|
5254
5315
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/bfdp_refresh_token_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5255
5316
|
},
|
|
5256
|
-
"x-
|
|
5317
|
+
"x-f5xc-cli-domain": "users"
|
|
5257
5318
|
},
|
|
5258
5319
|
"subscriptionSubscribeRequest": {
|
|
5259
5320
|
"type": "object",
|
|
@@ -5268,9 +5329,10 @@
|
|
|
5268
5329
|
"title": "Product_name.",
|
|
5269
5330
|
"x-displayname": "Product_name.",
|
|
5270
5331
|
"x-ves-example": "Product name.",
|
|
5332
|
+
"x-f5xc-example": "product name",
|
|
5271
5333
|
"minLength": 0,
|
|
5272
5334
|
"maxLength": 1024,
|
|
5273
|
-
"x-
|
|
5335
|
+
"x-f5xc-required-for": {
|
|
5274
5336
|
"minimum_config": false,
|
|
5275
5337
|
"create": false,
|
|
5276
5338
|
"update": false,
|
|
@@ -5278,7 +5340,7 @@
|
|
|
5278
5340
|
}
|
|
5279
5341
|
}
|
|
5280
5342
|
},
|
|
5281
|
-
"x-
|
|
5343
|
+
"x-f5xc-minimum-configuration": {
|
|
5282
5344
|
"description": "Minimum configuration for subscriptionSubscribeRequest",
|
|
5283
5345
|
"required_fields": [
|
|
5284
5346
|
"product_name"
|
|
@@ -5288,7 +5350,7 @@
|
|
|
5288
5350
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"product_name\": \"value\"\n }\n}",
|
|
5289
5351
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/subscription_subscribe_requests\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5290
5352
|
},
|
|
5291
|
-
"x-
|
|
5353
|
+
"x-f5xc-cli-domain": "billing_and_usage"
|
|
5292
5354
|
},
|
|
5293
5355
|
"subscriptionSubscribeResponse": {
|
|
5294
5356
|
"type": "object",
|
|
@@ -5303,9 +5365,10 @@
|
|
|
5303
5365
|
"title": "Configured_tenant_id.",
|
|
5304
5366
|
"x-displayname": "Configured_tenant_id.",
|
|
5305
5367
|
"x-ves-example": "Configured Tenant.",
|
|
5368
|
+
"x-f5xc-example": "Configured Tenant",
|
|
5306
5369
|
"minLength": 0,
|
|
5307
5370
|
"maxLength": 1024,
|
|
5308
|
-
"x-
|
|
5371
|
+
"x-f5xc-required-for": {
|
|
5309
5372
|
"minimum_config": false,
|
|
5310
5373
|
"create": false,
|
|
5311
5374
|
"update": false,
|
|
@@ -5319,9 +5382,10 @@
|
|
|
5319
5382
|
"title": "Pipleine_id.",
|
|
5320
5383
|
"x-displayname": "Pipleine_id.",
|
|
5321
5384
|
"x-ves-example": "Pipleine_id.",
|
|
5385
|
+
"x-f5xc-example": "pipleine_id",
|
|
5322
5386
|
"minLength": 0,
|
|
5323
5387
|
"maxLength": 1024,
|
|
5324
|
-
"x-
|
|
5388
|
+
"x-f5xc-required-for": {
|
|
5325
5389
|
"minimum_config": false,
|
|
5326
5390
|
"create": false,
|
|
5327
5391
|
"update": false,
|
|
@@ -5335,9 +5399,10 @@
|
|
|
5335
5399
|
"title": "Pipeline_name.",
|
|
5336
5400
|
"x-displayname": "Pipeline_name.",
|
|
5337
5401
|
"x-ves-example": "Pipeline_name.",
|
|
5402
|
+
"x-f5xc-example": "pipeline_name",
|
|
5338
5403
|
"minLength": 0,
|
|
5339
5404
|
"maxLength": 1024,
|
|
5340
|
-
"x-
|
|
5405
|
+
"x-f5xc-required-for": {
|
|
5341
5406
|
"minimum_config": false,
|
|
5342
5407
|
"create": false,
|
|
5343
5408
|
"update": false,
|
|
@@ -5350,9 +5415,10 @@
|
|
|
5350
5415
|
"title": "Token",
|
|
5351
5416
|
"x-displayname": "Token",
|
|
5352
5417
|
"x-ves-example": "Token name.",
|
|
5418
|
+
"x-f5xc-example": "token name",
|
|
5353
5419
|
"minLength": 0,
|
|
5354
5420
|
"maxLength": 1024,
|
|
5355
|
-
"x-
|
|
5421
|
+
"x-f5xc-required-for": {
|
|
5356
5422
|
"minimum_config": false,
|
|
5357
5423
|
"create": false,
|
|
5358
5424
|
"update": false,
|
|
@@ -5360,7 +5426,7 @@
|
|
|
5360
5426
|
}
|
|
5361
5427
|
}
|
|
5362
5428
|
},
|
|
5363
|
-
"x-
|
|
5429
|
+
"x-f5xc-minimum-configuration": {
|
|
5364
5430
|
"description": "Minimum configuration for subscriptionSubscribeResponse",
|
|
5365
5431
|
"required_fields": [
|
|
5366
5432
|
"configured_tenant_id",
|
|
@@ -5373,7 +5439,7 @@
|
|
|
5373
5439
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"configured_tenant_id\": \"value\",\n \"pipeline_id\": \"value\",\n \"pipeline_name\": \"value\",\n \"token\": \"value\"\n }\n}",
|
|
5374
5440
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/subscription_subscribe_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5375
5441
|
},
|
|
5376
|
-
"x-
|
|
5442
|
+
"x-f5xc-cli-domain": "billing_and_usage"
|
|
5377
5443
|
},
|
|
5378
5444
|
"subscriptionTokenRequest": {
|
|
5379
5445
|
"type": "object",
|
|
@@ -5388,9 +5454,10 @@
|
|
|
5388
5454
|
"title": "Product_name.",
|
|
5389
5455
|
"x-displayname": "Product_name.",
|
|
5390
5456
|
"x-ves-example": "Product name.",
|
|
5457
|
+
"x-f5xc-example": "product name",
|
|
5391
5458
|
"minLength": 0,
|
|
5392
5459
|
"maxLength": 1024,
|
|
5393
|
-
"x-
|
|
5460
|
+
"x-f5xc-required-for": {
|
|
5394
5461
|
"minimum_config": false,
|
|
5395
5462
|
"create": false,
|
|
5396
5463
|
"update": false,
|
|
@@ -5398,7 +5465,7 @@
|
|
|
5398
5465
|
}
|
|
5399
5466
|
}
|
|
5400
5467
|
},
|
|
5401
|
-
"x-
|
|
5468
|
+
"x-f5xc-minimum-configuration": {
|
|
5402
5469
|
"description": "Minimum configuration for subscriptionTokenRequest",
|
|
5403
5470
|
"required_fields": [
|
|
5404
5471
|
"product_name"
|
|
@@ -5408,7 +5475,7 @@
|
|
|
5408
5475
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"product_name\": \"value\"\n }\n}",
|
|
5409
5476
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/subscription_token_requests\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5410
5477
|
},
|
|
5411
|
-
"x-
|
|
5478
|
+
"x-f5xc-cli-domain": "users"
|
|
5412
5479
|
},
|
|
5413
5480
|
"subscriptionTokenResponse": {
|
|
5414
5481
|
"type": "object",
|
|
@@ -5423,9 +5490,10 @@
|
|
|
5423
5490
|
"title": "Product_name.",
|
|
5424
5491
|
"x-displayname": "Token",
|
|
5425
5492
|
"x-ves-example": "Workload identity JSON string or oauth2 token.",
|
|
5493
|
+
"x-f5xc-example": "workload identity json string or oauth2 token",
|
|
5426
5494
|
"minLength": 0,
|
|
5427
5495
|
"maxLength": 1024,
|
|
5428
|
-
"x-
|
|
5496
|
+
"x-f5xc-required-for": {
|
|
5429
5497
|
"minimum_config": false,
|
|
5430
5498
|
"create": false,
|
|
5431
5499
|
"update": false,
|
|
@@ -5433,7 +5501,7 @@
|
|
|
5433
5501
|
}
|
|
5434
5502
|
}
|
|
5435
5503
|
},
|
|
5436
|
-
"x-
|
|
5504
|
+
"x-f5xc-minimum-configuration": {
|
|
5437
5505
|
"description": "Minimum configuration for subscriptionTokenResponse",
|
|
5438
5506
|
"required_fields": [
|
|
5439
5507
|
"token"
|
|
@@ -5443,7 +5511,7 @@
|
|
|
5443
5511
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"token\": \"value\"\n }\n}",
|
|
5444
5512
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/subscription_token_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5445
5513
|
},
|
|
5446
|
-
"x-
|
|
5514
|
+
"x-f5xc-cli-domain": "users"
|
|
5447
5515
|
},
|
|
5448
5516
|
"subscriptionUnsubscribeRequest": {
|
|
5449
5517
|
"type": "object",
|
|
@@ -5458,9 +5526,10 @@
|
|
|
5458
5526
|
"title": "Product_name.",
|
|
5459
5527
|
"x-displayname": "Product_name.",
|
|
5460
5528
|
"x-ves-example": "Product name.",
|
|
5529
|
+
"x-f5xc-example": "product name",
|
|
5461
5530
|
"minLength": 0,
|
|
5462
5531
|
"maxLength": 1024,
|
|
5463
|
-
"x-
|
|
5532
|
+
"x-f5xc-required-for": {
|
|
5464
5533
|
"minimum_config": false,
|
|
5465
5534
|
"create": false,
|
|
5466
5535
|
"update": false,
|
|
@@ -5468,7 +5537,7 @@
|
|
|
5468
5537
|
}
|
|
5469
5538
|
}
|
|
5470
5539
|
},
|
|
5471
|
-
"x-
|
|
5540
|
+
"x-f5xc-minimum-configuration": {
|
|
5472
5541
|
"description": "Minimum configuration for subscriptionUnsubscribeRequest",
|
|
5473
5542
|
"required_fields": [
|
|
5474
5543
|
"product_name"
|
|
@@ -5478,7 +5547,7 @@
|
|
|
5478
5547
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"product_name\": \"value\"\n }\n}",
|
|
5479
5548
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/subscription_unsubscribe_requests\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5480
5549
|
},
|
|
5481
|
-
"x-
|
|
5550
|
+
"x-f5xc-cli-domain": "billing_and_usage"
|
|
5482
5551
|
},
|
|
5483
5552
|
"subscriptionUnsubscribeResponse": {
|
|
5484
5553
|
"type": "object",
|
|
@@ -5486,7 +5555,7 @@
|
|
|
5486
5555
|
"title": "UnsubscribeResponse.",
|
|
5487
5556
|
"x-displayname": "Unsubscribe Response.",
|
|
5488
5557
|
"x-ves-proto-message": "ves.io.schema.ai_data.bfdp.subscription.UnsubscribeResponse",
|
|
5489
|
-
"x-
|
|
5558
|
+
"x-f5xc-minimum-configuration": {
|
|
5490
5559
|
"description": "Minimum configuration for subscriptionUnsubscribeResponse",
|
|
5491
5560
|
"required_fields": [],
|
|
5492
5561
|
"mutually_exclusive_groups": [],
|
|
@@ -5494,7 +5563,7 @@
|
|
|
5494
5563
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
5495
5564
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/subscription_unsubscribe_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5496
5565
|
},
|
|
5497
|
-
"x-
|
|
5566
|
+
"x-f5xc-cli-domain": "billing_and_usage"
|
|
5498
5567
|
},
|
|
5499
5568
|
"giaAllocateIPRequest": {
|
|
5500
5569
|
"type": "object",
|
|
@@ -5509,9 +5578,10 @@
|
|
|
5509
5578
|
"title": "Context",
|
|
5510
5579
|
"x-displayname": "Context",
|
|
5511
5580
|
"x-ves-example": "App-VIP-pool-1.",
|
|
5581
|
+
"x-f5xc-example": "app-vip-pool-1",
|
|
5512
5582
|
"minLength": 0,
|
|
5513
5583
|
"maxLength": 1024,
|
|
5514
|
-
"x-
|
|
5584
|
+
"x-f5xc-required-for": {
|
|
5515
5585
|
"minimum_config": false,
|
|
5516
5586
|
"create": false,
|
|
5517
5587
|
"update": false,
|
|
@@ -5524,8 +5594,8 @@
|
|
|
5524
5594
|
"title": "Use_v6_range.",
|
|
5525
5595
|
"format": "boolean",
|
|
5526
5596
|
"x-displayname": "Use IPv6 Range.",
|
|
5527
|
-
"x-
|
|
5528
|
-
"x-
|
|
5597
|
+
"x-f5xc-example": "false",
|
|
5598
|
+
"x-f5xc-required-for": {
|
|
5529
5599
|
"minimum_config": false,
|
|
5530
5600
|
"create": false,
|
|
5531
5601
|
"update": false,
|
|
@@ -5533,7 +5603,7 @@
|
|
|
5533
5603
|
}
|
|
5534
5604
|
}
|
|
5535
5605
|
},
|
|
5536
|
-
"x-
|
|
5606
|
+
"x-f5xc-minimum-configuration": {
|
|
5537
5607
|
"description": "Minimum configuration for giaAllocateIPRequest",
|
|
5538
5608
|
"required_fields": [
|
|
5539
5609
|
"context",
|
|
@@ -5544,7 +5614,7 @@
|
|
|
5544
5614
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"context\": \"value\",\n \"use_v6_range\": \"value\"\n }\n}",
|
|
5545
5615
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/gia_allocate_i_p_requests\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5546
5616
|
},
|
|
5547
|
-
"x-
|
|
5617
|
+
"x-f5xc-cli-domain": "other"
|
|
5548
5618
|
},
|
|
5549
5619
|
"giaAllocateIPResponse": {
|
|
5550
5620
|
"type": "object",
|
|
@@ -5559,9 +5629,10 @@
|
|
|
5559
5629
|
"title": "Error_message.",
|
|
5560
5630
|
"x-displayname": "Error message.",
|
|
5561
5631
|
"x-ves-example": "GIA Internal Error.",
|
|
5632
|
+
"x-f5xc-example": "GIA Internal Error",
|
|
5562
5633
|
"minLength": 0,
|
|
5563
5634
|
"maxLength": 1024,
|
|
5564
|
-
"x-
|
|
5635
|
+
"x-f5xc-required-for": {
|
|
5565
5636
|
"minimum_config": false,
|
|
5566
5637
|
"create": false,
|
|
5567
5638
|
"update": false,
|
|
@@ -5574,9 +5645,10 @@
|
|
|
5574
5645
|
"title": "IP address.",
|
|
5575
5646
|
"x-displayname": "IP Address allocated.",
|
|
5576
5647
|
"x-ves-example": "192.168.0.1.",
|
|
5648
|
+
"x-f5xc-example": "192.168.0.1",
|
|
5577
5649
|
"minLength": 0,
|
|
5578
5650
|
"maxLength": 1024,
|
|
5579
|
-
"x-
|
|
5651
|
+
"x-f5xc-required-for": {
|
|
5580
5652
|
"minimum_config": false,
|
|
5581
5653
|
"create": false,
|
|
5582
5654
|
"update": false,
|
|
@@ -5584,7 +5656,7 @@
|
|
|
5584
5656
|
}
|
|
5585
5657
|
}
|
|
5586
5658
|
},
|
|
5587
|
-
"x-
|
|
5659
|
+
"x-f5xc-minimum-configuration": {
|
|
5588
5660
|
"description": "Minimum configuration for giaAllocateIPResponse",
|
|
5589
5661
|
"required_fields": [
|
|
5590
5662
|
"error_message",
|
|
@@ -5595,7 +5667,7 @@
|
|
|
5595
5667
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"error_message\": \"value\",\n \"ip\": \"value\"\n }\n}",
|
|
5596
5668
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/gia_allocate_i_p_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5597
5669
|
},
|
|
5598
|
-
"x-
|
|
5670
|
+
"x-f5xc-cli-domain": "other"
|
|
5599
5671
|
},
|
|
5600
5672
|
"giaDeallocateIPRequest": {
|
|
5601
5673
|
"type": "object",
|
|
@@ -5610,9 +5682,10 @@
|
|
|
5610
5682
|
"title": "Context",
|
|
5611
5683
|
"x-displayname": "Context",
|
|
5612
5684
|
"x-ves-example": "App-VIP-pool-1.",
|
|
5685
|
+
"x-f5xc-example": "app-vip-pool-1",
|
|
5613
5686
|
"minLength": 0,
|
|
5614
5687
|
"maxLength": 1024,
|
|
5615
|
-
"x-
|
|
5688
|
+
"x-f5xc-required-for": {
|
|
5616
5689
|
"minimum_config": false,
|
|
5617
5690
|
"create": false,
|
|
5618
5691
|
"update": false,
|
|
@@ -5628,13 +5701,13 @@
|
|
|
5628
5701
|
"x-ves-validation-rules": {
|
|
5629
5702
|
"ves.io.schema.rules.string.ip": "true"
|
|
5630
5703
|
},
|
|
5704
|
+
"x-f5xc-example": "192.168.0.1",
|
|
5631
5705
|
"x-validation-rules": {
|
|
5632
5706
|
"ves.io.schema.rules.string.ip": "true"
|
|
5633
5707
|
},
|
|
5634
5708
|
"minLength": 0,
|
|
5635
5709
|
"maxLength": 1024,
|
|
5636
|
-
"
|
|
5637
|
-
"x-ves-required-for": {
|
|
5710
|
+
"x-f5xc-required-for": {
|
|
5638
5711
|
"minimum_config": false,
|
|
5639
5712
|
"create": false,
|
|
5640
5713
|
"update": false,
|
|
@@ -5642,7 +5715,7 @@
|
|
|
5642
5715
|
}
|
|
5643
5716
|
}
|
|
5644
5717
|
},
|
|
5645
|
-
"x-
|
|
5718
|
+
"x-f5xc-minimum-configuration": {
|
|
5646
5719
|
"description": "Minimum configuration for giaDeallocateIPRequest",
|
|
5647
5720
|
"required_fields": [
|
|
5648
5721
|
"context",
|
|
@@ -5653,7 +5726,7 @@
|
|
|
5653
5726
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"context\": \"value\",\n \"ip\": \"value\"\n }\n}",
|
|
5654
5727
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/gia_deallocate_i_p_requests\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5655
5728
|
},
|
|
5656
|
-
"x-
|
|
5729
|
+
"x-f5xc-cli-domain": "other"
|
|
5657
5730
|
},
|
|
5658
5731
|
"giaDeallocateIPResponse": {
|
|
5659
5732
|
"type": "object",
|
|
@@ -5668,9 +5741,10 @@
|
|
|
5668
5741
|
"title": "Message",
|
|
5669
5742
|
"x-displayname": "Message",
|
|
5670
5743
|
"x-ves-example": "IP de-allocated successfully.",
|
|
5744
|
+
"x-f5xc-example": "IP de-allocated successfully",
|
|
5671
5745
|
"minLength": 0,
|
|
5672
5746
|
"maxLength": 1024,
|
|
5673
|
-
"x-
|
|
5747
|
+
"x-f5xc-required-for": {
|
|
5674
5748
|
"minimum_config": false,
|
|
5675
5749
|
"create": false,
|
|
5676
5750
|
"update": false,
|
|
@@ -5678,7 +5752,7 @@
|
|
|
5678
5752
|
}
|
|
5679
5753
|
}
|
|
5680
5754
|
},
|
|
5681
|
-
"x-
|
|
5755
|
+
"x-f5xc-minimum-configuration": {
|
|
5682
5756
|
"description": "Minimum configuration for giaDeallocateIPResponse",
|
|
5683
5757
|
"required_fields": [
|
|
5684
5758
|
"message"
|
|
@@ -5688,7 +5762,7 @@
|
|
|
5688
5762
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"message\": \"value\"\n }\n}",
|
|
5689
5763
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/gia_deallocate_i_p_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5690
5764
|
},
|
|
5691
|
-
"x-
|
|
5765
|
+
"x-f5xc-cli-domain": "other"
|
|
5692
5766
|
}
|
|
5693
5767
|
},
|
|
5694
5768
|
"responses": {},
|