@robinmordasiewicz/f5xc-api-mcp 2.0.10-2601051503 → 2.0.19-2601071557
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/CHANGELOG.md +25 -14
- package/README.md +9 -5
- package/dist/generator/domain-metadata.d.ts +1 -3
- package/dist/generator/domain-metadata.d.ts.map +1 -1
- package/dist/generator/domain-metadata.js +0 -20
- package/dist/generator/domain-metadata.js.map +1 -1
- package/dist/generator/naming/acronyms.d.ts +1 -1
- package/dist/generator/naming/acronyms.js +1 -1
- package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
- package/dist/tools/generated/ce_management/index.js +179 -1582
- package/dist/tools/generated/ce_management/index.js.map +1 -1
- package/dist/tools/generated/dependency-graph.json +2 -265
- package/dist/version.d.ts +2 -2
- package/dist/version.js +2 -2
- package/manifest.json +1 -1
- package/package.json +1 -1
- package/specs/domains/admin_console_and_ui.json +176 -26
- package/specs/domains/ai_services.json +242 -36
- package/specs/domains/api.json +1507 -183
- package/specs/domains/authentication.json +358 -46
- package/specs/domains/bigip.json +825 -105
- package/specs/domains/billing_and_usage.json +666 -83
- package/specs/domains/blindfold.json +988 -111
- package/specs/domains/bot_and_threat_defense.json +550 -66
- package/specs/domains/cdn.json +2431 -198
- package/specs/domains/ce_management.json +9272 -15726
- package/specs/domains/certificates.json +540 -78
- package/specs/domains/cloud_infrastructure.json +1102 -122
- package/specs/domains/container_services.json +782 -99
- package/specs/domains/data_and_privacy_security.json +508 -68
- package/specs/domains/data_intelligence.json +487 -64
- package/specs/domains/ddos.json +1302 -161
- package/specs/domains/dns.json +1286 -162
- package/specs/domains/managed_kubernetes.json +687 -89
- package/specs/domains/marketplace.json +994 -105
- package/specs/domains/network.json +2340 -239
- package/specs/domains/network_security.json +1963 -192
- package/specs/domains/nginx_one.json +475 -63
- package/specs/domains/object_storage.json +163 -16
- package/specs/domains/observability.json +1519 -148
- package/specs/domains/rate_limiting.json +456 -56
- package/specs/domains/secops_and_incident_response.json +275 -37
- package/specs/domains/service_mesh.json +1320 -128
- package/specs/domains/shape.json +4196 -398
- package/specs/domains/sites.json +5053 -405
- package/specs/domains/statistics.json +2784 -236
- package/specs/domains/support.json +1038 -109
- package/specs/domains/telemetry_and_insights.json +993 -80
- package/specs/domains/tenant_and_identity.json +3487 -313
- package/specs/domains/threat_campaign.json +695 -72
- package/specs/domains/users.json +437 -72
- package/specs/domains/virtual.json +3716 -261
- package/specs/domains/vpm_and_node_management.json +61 -2
- package/specs/domains/waf.json +1551 -149
- package/specs/index.json +121 -26
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Blindfold",
|
|
5
5
|
"description": "Public key retrieval and secret policy enforcement for encrypted data handling. Policy rules govern access with configurable matching and transformation actions. VoltShare integration provides decryption services, access counting, and audit log aggregation. Namespace-scoped policies enable fine-grained control over sensitive information with administrative overrides.",
|
|
6
|
-
"version": "2.0.
|
|
6
|
+
"version": "2.0.19",
|
|
7
7
|
"contact": {
|
|
8
8
|
"name": "F5 Distributed Cloud",
|
|
9
9
|
"url": "https://docs.cloud.f5.com"
|
|
@@ -13,7 +13,57 @@
|
|
|
13
13
|
"url": "https://www.f5.com/company/policies/eula"
|
|
14
14
|
},
|
|
15
15
|
"summary": "Encryption key management with policy-based access controls. Audit logging and secure data protection.",
|
|
16
|
-
"x-f5xc-cli-domain": "blindfold"
|
|
16
|
+
"x-f5xc-cli-domain": "blindfold",
|
|
17
|
+
"x-f5xc-best-practices": {
|
|
18
|
+
"common_errors": [
|
|
19
|
+
{
|
|
20
|
+
"code": 400,
|
|
21
|
+
"message": "Invalid request body",
|
|
22
|
+
"resolution": "Validate JSON structure and required fields before submission",
|
|
23
|
+
"prevention": "Use schema validation from OpenAPI spec"
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"code": 401,
|
|
27
|
+
"message": "Authentication failed",
|
|
28
|
+
"resolution": "Verify API token is valid and not expired",
|
|
29
|
+
"prevention": "Use environment variables for token management"
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"code": 403,
|
|
33
|
+
"message": "Permission denied",
|
|
34
|
+
"resolution": "Check user role and namespace permissions",
|
|
35
|
+
"prevention": "Verify RBAC policies before operations"
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
"code": 404,
|
|
39
|
+
"message": "Resource not found",
|
|
40
|
+
"resolution": "Verify resource name and namespace exist",
|
|
41
|
+
"prevention": "List resources before attempting operations"
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"code": 409,
|
|
45
|
+
"message": "Resource already exists",
|
|
46
|
+
"resolution": "Use unique name or delete existing resource",
|
|
47
|
+
"prevention": "Check existence before creation"
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"code": 429,
|
|
51
|
+
"message": "Rate limit exceeded",
|
|
52
|
+
"resolution": "Implement exponential backoff and retry logic",
|
|
53
|
+
"prevention": "Batch operations and add delays between requests"
|
|
54
|
+
}
|
|
55
|
+
],
|
|
56
|
+
"security_notes": [
|
|
57
|
+
"Always use HTTPS for all API communications",
|
|
58
|
+
"Store API tokens securely, never in source code",
|
|
59
|
+
"Rotate API tokens regularly following security policies"
|
|
60
|
+
],
|
|
61
|
+
"performance_tips": [
|
|
62
|
+
"Use pagination for large result sets",
|
|
63
|
+
"Batch related operations when possible",
|
|
64
|
+
"Cache read-only responses appropriately"
|
|
65
|
+
]
|
|
66
|
+
}
|
|
17
67
|
},
|
|
18
68
|
"servers": [
|
|
19
69
|
{
|
|
@@ -248,6 +298,13 @@
|
|
|
248
298
|
"latency": "moderate",
|
|
249
299
|
"resource_usage": "moderate"
|
|
250
300
|
}
|
|
301
|
+
},
|
|
302
|
+
"x-f5xc-discovered-response-time": {
|
|
303
|
+
"p50_ms": 200,
|
|
304
|
+
"p95_ms": 800,
|
|
305
|
+
"p99_ms": 2000,
|
|
306
|
+
"sample_count": 0,
|
|
307
|
+
"source": "estimate"
|
|
251
308
|
}
|
|
252
309
|
},
|
|
253
310
|
"x-displayname": "F5XC Secret Management.",
|
|
@@ -450,6 +507,13 @@
|
|
|
450
507
|
"latency": "moderate",
|
|
451
508
|
"resource_usage": "moderate"
|
|
452
509
|
}
|
|
510
|
+
},
|
|
511
|
+
"x-f5xc-discovered-response-time": {
|
|
512
|
+
"p50_ms": 200,
|
|
513
|
+
"p95_ms": 800,
|
|
514
|
+
"p99_ms": 2000,
|
|
515
|
+
"sample_count": 0,
|
|
516
|
+
"source": "estimate"
|
|
453
517
|
}
|
|
454
518
|
},
|
|
455
519
|
"x-displayname": "F5XC Secret Management.",
|
|
@@ -649,6 +713,13 @@
|
|
|
649
713
|
"latency": "low",
|
|
650
714
|
"resource_usage": "low"
|
|
651
715
|
}
|
|
716
|
+
},
|
|
717
|
+
"x-f5xc-discovered-response-time": {
|
|
718
|
+
"p50_ms": 1000,
|
|
719
|
+
"p95_ms": 3000,
|
|
720
|
+
"p99_ms": 8000,
|
|
721
|
+
"sample_count": 0,
|
|
722
|
+
"source": "estimate"
|
|
652
723
|
}
|
|
653
724
|
},
|
|
654
725
|
"x-displayname": "F5XC VoltShare.",
|
|
@@ -849,6 +920,13 @@
|
|
|
849
920
|
"latency": "low",
|
|
850
921
|
"resource_usage": "low"
|
|
851
922
|
}
|
|
923
|
+
},
|
|
924
|
+
"x-f5xc-discovered-response-time": {
|
|
925
|
+
"p50_ms": 1000,
|
|
926
|
+
"p95_ms": 3000,
|
|
927
|
+
"p99_ms": 8000,
|
|
928
|
+
"sample_count": 0,
|
|
929
|
+
"source": "estimate"
|
|
852
930
|
}
|
|
853
931
|
},
|
|
854
932
|
"x-displayname": "F5XC VoltShare.",
|
|
@@ -1063,6 +1141,13 @@
|
|
|
1063
1141
|
"latency": "low",
|
|
1064
1142
|
"resource_usage": "low"
|
|
1065
1143
|
}
|
|
1144
|
+
},
|
|
1145
|
+
"x-f5xc-discovered-response-time": {
|
|
1146
|
+
"p50_ms": 1000,
|
|
1147
|
+
"p95_ms": 3000,
|
|
1148
|
+
"p99_ms": 8000,
|
|
1149
|
+
"sample_count": 0,
|
|
1150
|
+
"source": "estimate"
|
|
1066
1151
|
}
|
|
1067
1152
|
},
|
|
1068
1153
|
"x-displayname": "F5XC VoltShare.",
|
|
@@ -1277,6 +1362,13 @@
|
|
|
1277
1362
|
"latency": "low",
|
|
1278
1363
|
"resource_usage": "low"
|
|
1279
1364
|
}
|
|
1365
|
+
},
|
|
1366
|
+
"x-f5xc-discovered-response-time": {
|
|
1367
|
+
"p50_ms": 1000,
|
|
1368
|
+
"p95_ms": 3000,
|
|
1369
|
+
"p99_ms": 8000,
|
|
1370
|
+
"sample_count": 0,
|
|
1371
|
+
"source": "estimate"
|
|
1280
1372
|
}
|
|
1281
1373
|
},
|
|
1282
1374
|
"x-displayname": "F5XC VoltShare.",
|
|
@@ -1491,6 +1583,13 @@
|
|
|
1491
1583
|
"latency": "low",
|
|
1492
1584
|
"resource_usage": "low"
|
|
1493
1585
|
}
|
|
1586
|
+
},
|
|
1587
|
+
"x-f5xc-discovered-response-time": {
|
|
1588
|
+
"p50_ms": 1000,
|
|
1589
|
+
"p95_ms": 3000,
|
|
1590
|
+
"p99_ms": 8000,
|
|
1591
|
+
"sample_count": 0,
|
|
1592
|
+
"source": "estimate"
|
|
1494
1593
|
}
|
|
1495
1594
|
},
|
|
1496
1595
|
"x-displayname": "F5XC VoltShare.",
|
|
@@ -1690,6 +1789,13 @@
|
|
|
1690
1789
|
"latency": "moderate",
|
|
1691
1790
|
"resource_usage": "moderate"
|
|
1692
1791
|
}
|
|
1792
|
+
},
|
|
1793
|
+
"x-f5xc-discovered-response-time": {
|
|
1794
|
+
"p50_ms": 200,
|
|
1795
|
+
"p95_ms": 800,
|
|
1796
|
+
"p99_ms": 2000,
|
|
1797
|
+
"sample_count": 0,
|
|
1798
|
+
"source": "estimate"
|
|
1693
1799
|
}
|
|
1694
1800
|
},
|
|
1695
1801
|
"post": {
|
|
@@ -1899,6 +2005,13 @@
|
|
|
1899
2005
|
"latency": "low",
|
|
1900
2006
|
"resource_usage": "low"
|
|
1901
2007
|
}
|
|
2008
|
+
},
|
|
2009
|
+
"x-f5xc-discovered-response-time": {
|
|
2010
|
+
"p50_ms": 1000,
|
|
2011
|
+
"p95_ms": 3000,
|
|
2012
|
+
"p99_ms": 8000,
|
|
2013
|
+
"sample_count": 0,
|
|
2014
|
+
"source": "estimate"
|
|
1902
2015
|
}
|
|
1903
2016
|
},
|
|
1904
2017
|
"x-displayname": "F5XC VoltShare.",
|
|
@@ -2113,6 +2226,13 @@
|
|
|
2113
2226
|
"latency": "low",
|
|
2114
2227
|
"resource_usage": "low"
|
|
2115
2228
|
}
|
|
2229
|
+
},
|
|
2230
|
+
"x-f5xc-discovered-response-time": {
|
|
2231
|
+
"p50_ms": 1000,
|
|
2232
|
+
"p95_ms": 3000,
|
|
2233
|
+
"p99_ms": 8000,
|
|
2234
|
+
"sample_count": 0,
|
|
2235
|
+
"source": "estimate"
|
|
2116
2236
|
}
|
|
2117
2237
|
},
|
|
2118
2238
|
"x-displayname": "Secret Management Access.",
|
|
@@ -2335,6 +2455,13 @@
|
|
|
2335
2455
|
"latency": "low",
|
|
2336
2456
|
"resource_usage": "low"
|
|
2337
2457
|
}
|
|
2458
|
+
},
|
|
2459
|
+
"x-f5xc-discovered-response-time": {
|
|
2460
|
+
"p50_ms": 800,
|
|
2461
|
+
"p95_ms": 2500,
|
|
2462
|
+
"p99_ms": 6000,
|
|
2463
|
+
"sample_count": 0,
|
|
2464
|
+
"source": "estimate"
|
|
2338
2465
|
}
|
|
2339
2466
|
},
|
|
2340
2467
|
"x-displayname": "Secret Management Access.",
|
|
@@ -2562,6 +2689,13 @@
|
|
|
2562
2689
|
"latency": "moderate",
|
|
2563
2690
|
"resource_usage": "moderate"
|
|
2564
2691
|
}
|
|
2692
|
+
},
|
|
2693
|
+
"x-f5xc-discovered-response-time": {
|
|
2694
|
+
"p50_ms": 200,
|
|
2695
|
+
"p95_ms": 800,
|
|
2696
|
+
"p99_ms": 2000,
|
|
2697
|
+
"sample_count": 0,
|
|
2698
|
+
"source": "estimate"
|
|
2565
2699
|
}
|
|
2566
2700
|
},
|
|
2567
2701
|
"x-displayname": "Secret Management Access.",
|
|
@@ -2783,6 +2917,13 @@
|
|
|
2783
2917
|
"latency": "low",
|
|
2784
2918
|
"resource_usage": "low"
|
|
2785
2919
|
}
|
|
2920
|
+
},
|
|
2921
|
+
"x-f5xc-discovered-response-time": {
|
|
2922
|
+
"p50_ms": 200,
|
|
2923
|
+
"p95_ms": 800,
|
|
2924
|
+
"p99_ms": 2000,
|
|
2925
|
+
"sample_count": 0,
|
|
2926
|
+
"source": "estimate"
|
|
2786
2927
|
}
|
|
2787
2928
|
},
|
|
2788
2929
|
"delete": {
|
|
@@ -3002,6 +3143,13 @@
|
|
|
3002
3143
|
"latency": "high",
|
|
3003
3144
|
"resource_usage": "moderate"
|
|
3004
3145
|
}
|
|
3146
|
+
},
|
|
3147
|
+
"x-f5xc-discovered-response-time": {
|
|
3148
|
+
"p50_ms": 500,
|
|
3149
|
+
"p95_ms": 1500,
|
|
3150
|
+
"p99_ms": 4000,
|
|
3151
|
+
"sample_count": 0,
|
|
3152
|
+
"source": "estimate"
|
|
3005
3153
|
}
|
|
3006
3154
|
},
|
|
3007
3155
|
"x-displayname": "Secret Management Access.",
|
|
@@ -3217,6 +3365,13 @@
|
|
|
3217
3365
|
"latency": "low",
|
|
3218
3366
|
"resource_usage": "low"
|
|
3219
3367
|
}
|
|
3368
|
+
},
|
|
3369
|
+
"x-f5xc-discovered-response-time": {
|
|
3370
|
+
"p50_ms": 1000,
|
|
3371
|
+
"p95_ms": 3000,
|
|
3372
|
+
"p99_ms": 8000,
|
|
3373
|
+
"sample_count": 0,
|
|
3374
|
+
"source": "estimate"
|
|
3220
3375
|
}
|
|
3221
3376
|
},
|
|
3222
3377
|
"x-displayname": "Secret Policy.",
|
|
@@ -3440,6 +3595,13 @@
|
|
|
3440
3595
|
"latency": "low",
|
|
3441
3596
|
"resource_usage": "low"
|
|
3442
3597
|
}
|
|
3598
|
+
},
|
|
3599
|
+
"x-f5xc-discovered-response-time": {
|
|
3600
|
+
"p50_ms": 800,
|
|
3601
|
+
"p95_ms": 2500,
|
|
3602
|
+
"p99_ms": 6000,
|
|
3603
|
+
"sample_count": 0,
|
|
3604
|
+
"source": "estimate"
|
|
3443
3605
|
}
|
|
3444
3606
|
},
|
|
3445
3607
|
"x-displayname": "Secret Policy.",
|
|
@@ -3642,6 +3804,13 @@
|
|
|
3642
3804
|
"latency": "low",
|
|
3643
3805
|
"resource_usage": "low"
|
|
3644
3806
|
}
|
|
3807
|
+
},
|
|
3808
|
+
"x-f5xc-discovered-response-time": {
|
|
3809
|
+
"p50_ms": 200,
|
|
3810
|
+
"p95_ms": 800,
|
|
3811
|
+
"p99_ms": 2000,
|
|
3812
|
+
"sample_count": 0,
|
|
3813
|
+
"source": "estimate"
|
|
3645
3814
|
}
|
|
3646
3815
|
},
|
|
3647
3816
|
"x-displayname": "Secret Policy.",
|
|
@@ -3870,6 +4039,13 @@
|
|
|
3870
4039
|
"latency": "low",
|
|
3871
4040
|
"resource_usage": "low"
|
|
3872
4041
|
}
|
|
4042
|
+
},
|
|
4043
|
+
"x-f5xc-discovered-response-time": {
|
|
4044
|
+
"p50_ms": 1000,
|
|
4045
|
+
"p95_ms": 3000,
|
|
4046
|
+
"p99_ms": 8000,
|
|
4047
|
+
"sample_count": 0,
|
|
4048
|
+
"source": "estimate"
|
|
3873
4049
|
}
|
|
3874
4050
|
},
|
|
3875
4051
|
"x-displayname": "Secret Policy.",
|
|
@@ -4098,6 +4274,13 @@
|
|
|
4098
4274
|
"latency": "low",
|
|
4099
4275
|
"resource_usage": "low"
|
|
4100
4276
|
}
|
|
4277
|
+
},
|
|
4278
|
+
"x-f5xc-discovered-response-time": {
|
|
4279
|
+
"p50_ms": 1000,
|
|
4280
|
+
"p95_ms": 3000,
|
|
4281
|
+
"p99_ms": 8000,
|
|
4282
|
+
"sample_count": 0,
|
|
4283
|
+
"source": "estimate"
|
|
4101
4284
|
}
|
|
4102
4285
|
},
|
|
4103
4286
|
"x-displayname": "Secret Policy.",
|
|
@@ -4326,6 +4509,13 @@
|
|
|
4326
4509
|
"latency": "moderate",
|
|
4327
4510
|
"resource_usage": "moderate"
|
|
4328
4511
|
}
|
|
4512
|
+
},
|
|
4513
|
+
"x-f5xc-discovered-response-time": {
|
|
4514
|
+
"p50_ms": 200,
|
|
4515
|
+
"p95_ms": 800,
|
|
4516
|
+
"p99_ms": 2000,
|
|
4517
|
+
"sample_count": 0,
|
|
4518
|
+
"source": "estimate"
|
|
4329
4519
|
}
|
|
4330
4520
|
},
|
|
4331
4521
|
"x-displayname": "Secret Policy.",
|
|
@@ -4548,6 +4738,13 @@
|
|
|
4548
4738
|
"latency": "low",
|
|
4549
4739
|
"resource_usage": "low"
|
|
4550
4740
|
}
|
|
4741
|
+
},
|
|
4742
|
+
"x-f5xc-discovered-response-time": {
|
|
4743
|
+
"p50_ms": 200,
|
|
4744
|
+
"p95_ms": 800,
|
|
4745
|
+
"p99_ms": 2000,
|
|
4746
|
+
"sample_count": 0,
|
|
4747
|
+
"source": "estimate"
|
|
4551
4748
|
}
|
|
4552
4749
|
},
|
|
4553
4750
|
"delete": {
|
|
@@ -4768,6 +4965,13 @@
|
|
|
4768
4965
|
"latency": "high",
|
|
4769
4966
|
"resource_usage": "moderate"
|
|
4770
4967
|
}
|
|
4968
|
+
},
|
|
4969
|
+
"x-f5xc-discovered-response-time": {
|
|
4970
|
+
"p50_ms": 500,
|
|
4971
|
+
"p95_ms": 1500,
|
|
4972
|
+
"p99_ms": 4000,
|
|
4973
|
+
"sample_count": 0,
|
|
4974
|
+
"source": "estimate"
|
|
4771
4975
|
}
|
|
4772
4976
|
},
|
|
4773
4977
|
"x-displayname": "Secret Policy.",
|
|
@@ -4983,6 +5187,13 @@
|
|
|
4983
5187
|
"latency": "low",
|
|
4984
5188
|
"resource_usage": "low"
|
|
4985
5189
|
}
|
|
5190
|
+
},
|
|
5191
|
+
"x-f5xc-discovered-response-time": {
|
|
5192
|
+
"p50_ms": 1000,
|
|
5193
|
+
"p95_ms": 3000,
|
|
5194
|
+
"p99_ms": 8000,
|
|
5195
|
+
"sample_count": 0,
|
|
5196
|
+
"source": "estimate"
|
|
4986
5197
|
}
|
|
4987
5198
|
},
|
|
4988
5199
|
"x-displayname": "Secret Policy Rule.",
|
|
@@ -5206,6 +5417,13 @@
|
|
|
5206
5417
|
"latency": "low",
|
|
5207
5418
|
"resource_usage": "low"
|
|
5208
5419
|
}
|
|
5420
|
+
},
|
|
5421
|
+
"x-f5xc-discovered-response-time": {
|
|
5422
|
+
"p50_ms": 800,
|
|
5423
|
+
"p95_ms": 2500,
|
|
5424
|
+
"p99_ms": 6000,
|
|
5425
|
+
"sample_count": 0,
|
|
5426
|
+
"source": "estimate"
|
|
5209
5427
|
}
|
|
5210
5428
|
},
|
|
5211
5429
|
"x-displayname": "Secret Policy Rule.",
|
|
@@ -5434,6 +5652,13 @@
|
|
|
5434
5652
|
"latency": "moderate",
|
|
5435
5653
|
"resource_usage": "moderate"
|
|
5436
5654
|
}
|
|
5655
|
+
},
|
|
5656
|
+
"x-f5xc-discovered-response-time": {
|
|
5657
|
+
"p50_ms": 200,
|
|
5658
|
+
"p95_ms": 800,
|
|
5659
|
+
"p99_ms": 2000,
|
|
5660
|
+
"sample_count": 0,
|
|
5661
|
+
"source": "estimate"
|
|
5437
5662
|
}
|
|
5438
5663
|
},
|
|
5439
5664
|
"x-displayname": "Secret Policy Rule.",
|
|
@@ -5656,6 +5881,13 @@
|
|
|
5656
5881
|
"latency": "low",
|
|
5657
5882
|
"resource_usage": "low"
|
|
5658
5883
|
}
|
|
5884
|
+
},
|
|
5885
|
+
"x-f5xc-discovered-response-time": {
|
|
5886
|
+
"p50_ms": 200,
|
|
5887
|
+
"p95_ms": 800,
|
|
5888
|
+
"p99_ms": 2000,
|
|
5889
|
+
"sample_count": 0,
|
|
5890
|
+
"source": "estimate"
|
|
5659
5891
|
}
|
|
5660
5892
|
},
|
|
5661
5893
|
"delete": {
|
|
@@ -5876,6 +6108,13 @@
|
|
|
5876
6108
|
"latency": "high",
|
|
5877
6109
|
"resource_usage": "moderate"
|
|
5878
6110
|
}
|
|
6111
|
+
},
|
|
6112
|
+
"x-f5xc-discovered-response-time": {
|
|
6113
|
+
"p50_ms": 500,
|
|
6114
|
+
"p95_ms": 1500,
|
|
6115
|
+
"p99_ms": 4000,
|
|
6116
|
+
"sample_count": 0,
|
|
6117
|
+
"source": "estimate"
|
|
5879
6118
|
}
|
|
5880
6119
|
},
|
|
5881
6120
|
"x-displayname": "Secret Policy Rule.",
|
|
@@ -6091,6 +6330,13 @@
|
|
|
6091
6330
|
"latency": "low",
|
|
6092
6331
|
"resource_usage": "low"
|
|
6093
6332
|
}
|
|
6333
|
+
},
|
|
6334
|
+
"x-f5xc-discovered-response-time": {
|
|
6335
|
+
"p50_ms": 1000,
|
|
6336
|
+
"p95_ms": 3000,
|
|
6337
|
+
"p99_ms": 8000,
|
|
6338
|
+
"sample_count": 0,
|
|
6339
|
+
"source": "estimate"
|
|
6094
6340
|
}
|
|
6095
6341
|
},
|
|
6096
6342
|
"x-displayname": "VoltShare Admin Policy.",
|
|
@@ -6314,6 +6560,13 @@
|
|
|
6314
6560
|
"latency": "low",
|
|
6315
6561
|
"resource_usage": "low"
|
|
6316
6562
|
}
|
|
6563
|
+
},
|
|
6564
|
+
"x-f5xc-discovered-response-time": {
|
|
6565
|
+
"p50_ms": 800,
|
|
6566
|
+
"p95_ms": 2500,
|
|
6567
|
+
"p99_ms": 6000,
|
|
6568
|
+
"sample_count": 0,
|
|
6569
|
+
"source": "estimate"
|
|
6317
6570
|
}
|
|
6318
6571
|
},
|
|
6319
6572
|
"x-displayname": "VoltShare Admin Policy.",
|
|
@@ -6542,6 +6795,13 @@
|
|
|
6542
6795
|
"latency": "moderate",
|
|
6543
6796
|
"resource_usage": "moderate"
|
|
6544
6797
|
}
|
|
6798
|
+
},
|
|
6799
|
+
"x-f5xc-discovered-response-time": {
|
|
6800
|
+
"p50_ms": 200,
|
|
6801
|
+
"p95_ms": 800,
|
|
6802
|
+
"p99_ms": 2000,
|
|
6803
|
+
"sample_count": 0,
|
|
6804
|
+
"source": "estimate"
|
|
6545
6805
|
}
|
|
6546
6806
|
},
|
|
6547
6807
|
"x-displayname": "VoltShare Admin Policy.",
|
|
@@ -6764,6 +7024,13 @@
|
|
|
6764
7024
|
"latency": "low",
|
|
6765
7025
|
"resource_usage": "low"
|
|
6766
7026
|
}
|
|
7027
|
+
},
|
|
7028
|
+
"x-f5xc-discovered-response-time": {
|
|
7029
|
+
"p50_ms": 200,
|
|
7030
|
+
"p95_ms": 800,
|
|
7031
|
+
"p99_ms": 2000,
|
|
7032
|
+
"sample_count": 0,
|
|
7033
|
+
"source": "estimate"
|
|
6767
7034
|
}
|
|
6768
7035
|
},
|
|
6769
7036
|
"delete": {
|
|
@@ -6984,6 +7251,13 @@
|
|
|
6984
7251
|
"latency": "high",
|
|
6985
7252
|
"resource_usage": "moderate"
|
|
6986
7253
|
}
|
|
7254
|
+
},
|
|
7255
|
+
"x-f5xc-discovered-response-time": {
|
|
7256
|
+
"p50_ms": 500,
|
|
7257
|
+
"p95_ms": 1500,
|
|
7258
|
+
"p99_ms": 4000,
|
|
7259
|
+
"sample_count": 0,
|
|
7260
|
+
"source": "estimate"
|
|
6987
7261
|
}
|
|
6988
7262
|
},
|
|
6989
7263
|
"x-displayname": "VoltShare Admin Policy.",
|
|
@@ -7032,6 +7306,7 @@
|
|
|
7032
7306
|
"ves.io.schema.rules.repeated.max_items": "64",
|
|
7033
7307
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
7034
7308
|
},
|
|
7309
|
+
"x-f5xc-description-short": "List of exact values to match the input against.",
|
|
7035
7310
|
"x-f5xc-required-for": {
|
|
7036
7311
|
"minimum_config": false,
|
|
7037
7312
|
"create": false,
|
|
@@ -7065,6 +7340,7 @@
|
|
|
7065
7340
|
"ves.io.schema.rules.repeated.max_items": "16",
|
|
7066
7341
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
7067
7342
|
},
|
|
7343
|
+
"x-f5xc-description-short": "List of regular expressions to match the input against.",
|
|
7068
7344
|
"x-f5xc-required-for": {
|
|
7069
7345
|
"minimum_config": false,
|
|
7070
7346
|
"create": false,
|
|
@@ -7090,6 +7366,7 @@
|
|
|
7090
7366
|
"ves.io.schema.rules.repeated.max_items": "9",
|
|
7091
7367
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
7092
7368
|
},
|
|
7369
|
+
"x-f5xc-description-short": "Ordered list of transformers (starting from index 0) to be applied to the path before matching.",
|
|
7093
7370
|
"x-f5xc-required-for": {
|
|
7094
7371
|
"minimum_config": false,
|
|
7095
7372
|
"create": false,
|
|
@@ -7098,6 +7375,8 @@
|
|
|
7098
7375
|
}
|
|
7099
7376
|
}
|
|
7100
7377
|
},
|
|
7378
|
+
"x-f5xc-description-short": "Matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied.",
|
|
7379
|
+
"x-f5xc-description-medium": "Matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set of supported match criteria includes a list of exact values and a list of regular expressions.",
|
|
7101
7380
|
"x-f5xc-minimum-configuration": {
|
|
7102
7381
|
"description": "Minimum configuration for policyMatcherType",
|
|
7103
7382
|
"required_fields": [
|
|
@@ -7124,6 +7403,8 @@
|
|
|
7124
7403
|
"default": "DENY",
|
|
7125
7404
|
"x-displayname": "Rule Action.",
|
|
7126
7405
|
"x-ves-proto-enum": "ves.io.schema.policy.RuleAction",
|
|
7406
|
+
"x-f5xc-description-short": "The rule action determines the disposition of the input request API.",
|
|
7407
|
+
"x-f5xc-description-medium": "The rule action determines the disposition of the input request API. If a policy matches a rule with an ALLOW action, the processing of the request proceeds forward. If it matches a rule with a DENY action, the processing of the request is terminated and an appropriate message/code returned to...",
|
|
7127
7408
|
"x-f5xc-minimum-configuration": {
|
|
7128
7409
|
"description": "Minimum configuration for policyRuleAction",
|
|
7129
7410
|
"required_fields": [],
|
|
@@ -7146,6 +7427,8 @@
|
|
|
7146
7427
|
"default": "FIRST_MATCH",
|
|
7147
7428
|
"x-displayname": "Rule Combining Algorithm.",
|
|
7148
7429
|
"x-ves-proto-enum": "ves.io.schema.policy.RuleCombiningAlgorithm",
|
|
7430
|
+
"x-f5xc-description-short": "The rule combining algorithm for a policy determines how the list of rules in the policy is evaluated.",
|
|
7431
|
+
"x-f5xc-description-medium": "The rule combining algorithm for a policy determines how the list of rules in the policy is evaluated. If any of the rules is configured with a App Firewall action, the rule combining algorithm must be configured to be FIRST_MATCH. - FIRST_MATCH Rules are evaluated sequentially till a matching...",
|
|
7149
7432
|
"x-f5xc-minimum-configuration": {
|
|
7150
7433
|
"description": "Minimum configuration for policyRuleCombiningAlgorithm",
|
|
7151
7434
|
"required_fields": [],
|
|
@@ -7174,6 +7457,8 @@
|
|
|
7174
7457
|
"default": "TRANSFORMER_NONE",
|
|
7175
7458
|
"x-displayname": "Transformer.",
|
|
7176
7459
|
"x-ves-proto-enum": "ves.io.schema.policy.Transformer",
|
|
7460
|
+
"x-f5xc-description-short": "Transformers to be applied on the part of the request before matching. - TRANSFORMER_NONE: transformer none No transformers enabled - LOWER_CASE...",
|
|
7461
|
+
"x-f5xc-description-medium": "Transformers to be applied on the part of the request before matching. - TRANSFORMER_NONE: transformer none No transformers enabled - LOWER_CASE: lower case Convert string to lower case - UPPER_CASE: upper case Convert string to upper case - BASE64_DECODE: base64 decode Decode string assuming...",
|
|
7177
7462
|
"x-f5xc-minimum-configuration": {
|
|
7178
7463
|
"description": "Minimum configuration for policyTransformer",
|
|
7179
7464
|
"required_fields": [],
|
|
@@ -7197,6 +7482,7 @@
|
|
|
7197
7482
|
"type": "string"
|
|
7198
7483
|
},
|
|
7199
7484
|
"x-f5xc-example": "['environment', 'location', 'deployment']",
|
|
7485
|
+
"x-f5xc-description-short": "X-displayName: \"Keys\" The list of label key names that have to match.",
|
|
7200
7486
|
"x-f5xc-required-for": {
|
|
7201
7487
|
"minimum_config": false,
|
|
7202
7488
|
"create": false,
|
|
@@ -7205,6 +7491,8 @@
|
|
|
7205
7491
|
}
|
|
7206
7492
|
}
|
|
7207
7493
|
},
|
|
7494
|
+
"x-f5xc-description-short": "X-displayName: \"Label Matcher\" A label matcher specifies a list of label keys whose values need to match for source/client and destination/server.",
|
|
7495
|
+
"x-f5xc-description-medium": "X-displayName: \"Label Matcher\" A label matcher specifies a list of label keys whose values need to match for source/client and destination/server. Note that the actual label values are not specified and do not matter. This allows an ability to scope grouping by the label key name.",
|
|
7208
7496
|
"x-f5xc-minimum-configuration": {
|
|
7209
7497
|
"description": "Minimum configuration for schemaLabelMatcherType",
|
|
7210
7498
|
"required_fields": [
|
|
@@ -7252,6 +7540,7 @@
|
|
|
7252
7540
|
"ves.io.schema.rules.repeated.items.string.min_len": "1",
|
|
7253
7541
|
"ves.io.schema.rules.repeated.max_items": "1"
|
|
7254
7542
|
},
|
|
7543
|
+
"x-f5xc-description-short": "Expressions contains the Kubernetes style label expression for selections. Required: YES.",
|
|
7255
7544
|
"x-f5xc-required-for": {
|
|
7256
7545
|
"minimum_config": false,
|
|
7257
7546
|
"create": false,
|
|
@@ -7260,6 +7549,8 @@
|
|
|
7260
7549
|
}
|
|
7261
7550
|
}
|
|
7262
7551
|
},
|
|
7552
|
+
"x-f5xc-description-short": "Type can be used to establish a 'selector reference' from one object(called selector) to a set of other objects(called selectees) based on the...",
|
|
7553
|
+
"x-f5xc-description-medium": "Type can be used to establish a 'selector reference' from one object(called selector) to a set of other objects(called selectees) based on the value of expresssions. A label selector is a label query over a set of resources. An empty label selector matches all objects.",
|
|
7263
7554
|
"x-f5xc-minimum-configuration": {
|
|
7264
7555
|
"description": "Minimum configuration for schemaLabelSelectorType",
|
|
7265
7556
|
"required_fields": [
|
|
@@ -7297,6 +7588,8 @@
|
|
|
7297
7588
|
"x-validation-rules": {
|
|
7298
7589
|
"ves.io.schema.rules.string.max_bytes": "256"
|
|
7299
7590
|
},
|
|
7591
|
+
"x-f5xc-description-short": "Exclusive with [client_name_matcher client_selector] The name of the client trying to access the secret.",
|
|
7592
|
+
"x-f5xc-description-medium": "Exclusive with [client_name_matcher client_selector] The name of the client trying to access the secret. Name of the client will be extracted from client TLS certificate. This predicate evaluates to true if client name matches the configured name.",
|
|
7300
7593
|
"minLength": 0,
|
|
7301
7594
|
"x-f5xc-required-for": {
|
|
7302
7595
|
"minimum_config": false,
|
|
@@ -7312,6 +7605,8 @@
|
|
|
7312
7605
|
"$ref": "#/components/schemas/schemaLabelSelectorType"
|
|
7313
7606
|
}
|
|
7314
7607
|
},
|
|
7608
|
+
"x-f5xc-description-short": "Secret_policy_rule object consists of an unordered list of predicates and an action.",
|
|
7609
|
+
"x-f5xc-description-medium": "Secret_policy_rule object consists of an unordered list of predicates and an action. The predicates are evaluated against a set of input fields that are extracted from client certificate. A rule is considered to match if all predicates in the rule evaluate to true for that request.",
|
|
7315
7610
|
"x-f5xc-minimum-configuration": {
|
|
7316
7611
|
"description": "Minimum configuration for schemasecret_policy_ruleGlobalSpecType",
|
|
7317
7612
|
"required_fields": [
|
|
@@ -7338,6 +7633,8 @@
|
|
|
7338
7633
|
"$ref": "#/components/schemas/secret_managementPolicyData"
|
|
7339
7634
|
}
|
|
7340
7635
|
},
|
|
7636
|
+
"x-f5xc-description-short": "Policy Document contains the information about the secret policy and all the secret policy rules for the policy.",
|
|
7637
|
+
"x-f5xc-description-medium": "Policy Document contains the information about the secret policy and all the secret policy rules for the policy. This document can be given to F5 Distributed Cloud secret management tool to do secret encryption.",
|
|
7341
7638
|
"x-f5xc-minimum-configuration": {
|
|
7342
7639
|
"description": "Minimum configuration for secret_managementGetPolicyDocumentResponse",
|
|
7343
7640
|
"required_fields": [
|
|
@@ -7361,6 +7658,8 @@
|
|
|
7361
7658
|
"$ref": "#/components/schemas/secret_managementKeyData"
|
|
7362
7659
|
}
|
|
7363
7660
|
},
|
|
7661
|
+
"x-f5xc-description-short": "F5XC Secret Management uses asymmetric cryptography for securing secrets.",
|
|
7662
|
+
"x-f5xc-description-medium": "F5XC Secret Management uses asymmetric cryptography for securing secrets. Each tenant will be assigned a <public,private> keypair for secret management at registration time. While private part of the key never leaves F5 Distributed Cloud secret management, public part of this asymmetric key is...",
|
|
7364
7663
|
"x-f5xc-minimum-configuration": {
|
|
7365
7664
|
"description": "Minimum configuration for secret_managementGetPublicKeyResponse",
|
|
7366
7665
|
"required_fields": [
|
|
@@ -7382,7 +7681,7 @@
|
|
|
7382
7681
|
"properties": {
|
|
7383
7682
|
"key_version": {
|
|
7384
7683
|
"type": "integer",
|
|
7385
|
-
"description": "",
|
|
7684
|
+
"description": "Version number or identifier",
|
|
7386
7685
|
"title": "Key_version.",
|
|
7387
7686
|
"format": "int64",
|
|
7388
7687
|
"x-displayname": "Version of the key.",
|
|
@@ -7420,6 +7719,7 @@
|
|
|
7420
7719
|
"x-displayname": "Public Exponent.",
|
|
7421
7720
|
"x-ves-example": "Value",
|
|
7422
7721
|
"x-f5xc-example": "value",
|
|
7722
|
+
"x-f5xc-description-short": "Public Exponent as Base64 encoded string.",
|
|
7423
7723
|
"minLength": 0,
|
|
7424
7724
|
"maxLength": 1024,
|
|
7425
7725
|
"x-f5xc-required-for": {
|
|
@@ -7447,9 +7747,11 @@
|
|
|
7447
7747
|
"x-field-mutability": "read-only",
|
|
7448
7748
|
"x-original-maxLength": 1024,
|
|
7449
7749
|
"x-reconciled-from-discovery": true,
|
|
7450
|
-
"x-reconciled-at": "2026-01-
|
|
7750
|
+
"x-reconciled-at": "2026-01-07T15:28:36.879487+00:00"
|
|
7451
7751
|
}
|
|
7452
7752
|
},
|
|
7753
|
+
"x-f5xc-description-short": "F5XC Secret Management uses asymmetric cryptography for securing secrets.",
|
|
7754
|
+
"x-f5xc-description-medium": "F5XC Secret Management uses asymmetric cryptography for securing secrets. Each tenant will be assigned a <public,private> keypair for secret management at registration time. While private part of the key never leaves F5 Distributed Cloud secret management, public part of this asymmetric key is...",
|
|
7453
7755
|
"x-f5xc-minimum-configuration": {
|
|
7454
7756
|
"description": "Minimum configuration for secret_managementKeyData",
|
|
7455
7757
|
"required_fields": [
|
|
@@ -7489,7 +7791,7 @@
|
|
|
7489
7791
|
},
|
|
7490
7792
|
"x-original-maxLength": 1024,
|
|
7491
7793
|
"x-reconciled-from-discovery": true,
|
|
7492
|
-
"x-reconciled-at": "2026-01-
|
|
7794
|
+
"x-reconciled-at": "2026-01-07T15:28:36.879495+00:00"
|
|
7493
7795
|
},
|
|
7494
7796
|
"namespace": {
|
|
7495
7797
|
"type": "string",
|
|
@@ -7508,7 +7810,7 @@
|
|
|
7508
7810
|
},
|
|
7509
7811
|
"x-original-maxLength": 1024,
|
|
7510
7812
|
"x-reconciled-from-discovery": true,
|
|
7511
|
-
"x-reconciled-at": "2026-01-
|
|
7813
|
+
"x-reconciled-at": "2026-01-07T15:28:36.879500+00:00"
|
|
7512
7814
|
},
|
|
7513
7815
|
"policy_id": {
|
|
7514
7816
|
"type": "string",
|
|
@@ -7526,6 +7828,8 @@
|
|
|
7526
7828
|
"ves.io.schema.rules.uint64.gte": "0",
|
|
7527
7829
|
"ves.io.schema.rules.uint64.lte": "2147483647"
|
|
7528
7830
|
},
|
|
7831
|
+
"x-f5xc-description-short": "PolicyID for the policy. PolicyID is an integer ID which uniquely identifies the policy in given tenant.",
|
|
7832
|
+
"x-f5xc-description-medium": "PolicyID for the policy. PolicyID is an integer ID which uniquely identifies the policy in given tenant.",
|
|
7529
7833
|
"minLength": 0,
|
|
7530
7834
|
"maxLength": 1024,
|
|
7531
7835
|
"x-f5xc-required-for": {
|
|
@@ -7557,9 +7861,11 @@
|
|
|
7557
7861
|
"x-field-mutability": "read-only",
|
|
7558
7862
|
"x-original-maxLength": 1024,
|
|
7559
7863
|
"x-reconciled-from-discovery": true,
|
|
7560
|
-
"x-reconciled-at": "2026-01-
|
|
7864
|
+
"x-reconciled-at": "2026-01-07T15:28:36.879523+00:00"
|
|
7561
7865
|
}
|
|
7562
7866
|
},
|
|
7867
|
+
"x-f5xc-description-short": "Policy_data contains the information about the secret policy and all the secret policy rules for the policy.",
|
|
7868
|
+
"x-f5xc-description-medium": "Policy_data contains the information about the secret policy and all the secret policy rules for the policy.",
|
|
7563
7869
|
"x-f5xc-minimum-configuration": {
|
|
7564
7870
|
"description": "Minimum configuration for secret_managementPolicyData",
|
|
7565
7871
|
"required_fields": [
|
|
@@ -7594,6 +7900,9 @@
|
|
|
7594
7900
|
"$ref": "#/components/schemas/schemasecret_policy_ruleGlobalSpecType"
|
|
7595
7901
|
},
|
|
7596
7902
|
"x-displayname": "Secret Policy Rules.",
|
|
7903
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7904
|
+
"x-f5xc-description-short": "List of references to secret_policy_rule objects. The order of evaluation of the rules depends on the rule combining algorithm.",
|
|
7905
|
+
"x-f5xc-description-medium": "List of references to secret_policy_rule objects. The order of evaluation of the rules depends on the rule combining algorithm.",
|
|
7597
7906
|
"x-f5xc-required-for": {
|
|
7598
7907
|
"minimum_config": false,
|
|
7599
7908
|
"create": false,
|
|
@@ -7602,6 +7911,7 @@
|
|
|
7602
7911
|
}
|
|
7603
7912
|
}
|
|
7604
7913
|
},
|
|
7914
|
+
"x-f5xc-description-short": "Policy_information contains the shape and specifications of the secret policy.",
|
|
7605
7915
|
"x-f5xc-minimum-configuration": {
|
|
7606
7916
|
"description": "Minimum configuration for secret_managementPolicyInfoType",
|
|
7607
7917
|
"required_fields": [
|
|
@@ -7627,6 +7937,8 @@
|
|
|
7627
7937
|
"$ref": "#/components/schemas/logFieldAggregation"
|
|
7628
7938
|
}
|
|
7629
7939
|
},
|
|
7940
|
+
"x-f5xc-description-short": "X-displayName: \"Aggregation Request\" Aggregation request to provide analytics data over the log response.",
|
|
7941
|
+
"x-f5xc-description-medium": "X-displayName: \"Aggregation Request\" Aggregation request to provide analytics data over the log response.",
|
|
7630
7942
|
"x-f5xc-minimum-configuration": {
|
|
7631
7943
|
"description": "Minimum configuration for logAggregationRequest",
|
|
7632
7944
|
"required_fields": [
|
|
@@ -7659,9 +7971,10 @@
|
|
|
7659
7971
|
"maxLength": 15,
|
|
7660
7972
|
"minLength": 3,
|
|
7661
7973
|
"x-reconciled-from-discovery": true,
|
|
7662
|
-
"x-reconciled-at": "2026-01-
|
|
7974
|
+
"x-reconciled-at": "2026-01-07T15:28:37.307768+00:00"
|
|
7663
7975
|
}
|
|
7664
7976
|
},
|
|
7977
|
+
"x-f5xc-description-short": "X-displayName: \"Avg Aggregation Data\" Average Aggregation data.",
|
|
7665
7978
|
"x-f5xc-minimum-configuration": {
|
|
7666
7979
|
"description": "Minimum configuration for logAvgAggregationData",
|
|
7667
7980
|
"required_fields": [
|
|
@@ -7684,6 +7997,7 @@
|
|
|
7684
7997
|
"description": "X-displayName: \"Count\"\nx-example: 100\nCount of distinct values of a log field.",
|
|
7685
7998
|
"title": "Count",
|
|
7686
7999
|
"format": "uint64",
|
|
8000
|
+
"x-f5xc-example": "42",
|
|
7687
8001
|
"minLength": 0,
|
|
7688
8002
|
"maxLength": 1024,
|
|
7689
8003
|
"x-f5xc-required-for": {
|
|
@@ -7697,6 +8011,8 @@
|
|
|
7697
8011
|
"$ref": "#/components/schemas/schemaTrendValue"
|
|
7698
8012
|
}
|
|
7699
8013
|
},
|
|
8014
|
+
"x-f5xc-description-short": "X-displayName: \"Cardinality Aggregation Data\" Approximate count of distinct values of the log field specified in the request.",
|
|
8015
|
+
"x-f5xc-description-medium": "X-displayName: \"Cardinality Aggregation Data\" Approximate count of distinct values of the log field specified in the request.",
|
|
7700
8016
|
"x-f5xc-minimum-configuration": {
|
|
7701
8017
|
"description": "Minimum configuration for logCardinalityAggregationData",
|
|
7702
8018
|
"required_fields": [
|
|
@@ -7720,6 +8036,8 @@
|
|
|
7720
8036
|
"description": "X-displayName: \"Step\"\nx-required\nstep is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
|
|
7721
8037
|
"title": "Step",
|
|
7722
8038
|
"x-f5xc-example": "5m",
|
|
8039
|
+
"x-f5xc-description-short": "X-displayName: \"Step\" x-required step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in...",
|
|
8040
|
+
"x-f5xc-description-medium": "X-displayName: \"Step\" x-required step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
|
|
7723
8041
|
"minLength": 0,
|
|
7724
8042
|
"maxLength": 1024,
|
|
7725
8043
|
"x-f5xc-required-for": {
|
|
@@ -7733,6 +8051,7 @@
|
|
|
7733
8051
|
"type": "object",
|
|
7734
8052
|
"description": "X-displayName: \"Sub Aggregation\"\nThis option provides sub-aggregation for each date bucket.",
|
|
7735
8053
|
"title": "Sub aggregation.",
|
|
8054
|
+
"x-f5xc-description-short": "X-displayName: \"Sub Aggregation\" This option provides sub-aggregation for each date bucket.",
|
|
7736
8055
|
"x-f5xc-required-for": {
|
|
7737
8056
|
"minimum_config": false,
|
|
7738
8057
|
"create": false,
|
|
@@ -7741,6 +8060,7 @@
|
|
|
7741
8060
|
}
|
|
7742
8061
|
}
|
|
7743
8062
|
},
|
|
8063
|
+
"x-f5xc-description-short": "X-displayName: \"Date Aggregation\" Aggregate access logs based on timestamp in the log.",
|
|
7744
8064
|
"x-f5xc-minimum-configuration": {
|
|
7745
8065
|
"description": "Minimum configuration for logDateAggregation",
|
|
7746
8066
|
"required_fields": [
|
|
@@ -7764,6 +8084,7 @@
|
|
|
7764
8084
|
"description": "X-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket.",
|
|
7765
8085
|
"title": "Count",
|
|
7766
8086
|
"format": "uint64",
|
|
8087
|
+
"x-f5xc-example": "42",
|
|
7767
8088
|
"minLength": 0,
|
|
7768
8089
|
"maxLength": 1024,
|
|
7769
8090
|
"x-f5xc-required-for": {
|
|
@@ -7777,6 +8098,7 @@
|
|
|
7777
8098
|
"type": "object",
|
|
7778
8099
|
"description": "X-displayName: \"Sub Aggregation\"\nSub aggregation data for the date bucket.",
|
|
7779
8100
|
"title": "Sub aggregation.",
|
|
8101
|
+
"x-f5xc-description-short": "X-displayName: \"Sub Aggregation\" Sub aggregation data for the date bucket.",
|
|
7780
8102
|
"x-f5xc-required-for": {
|
|
7781
8103
|
"minimum_config": false,
|
|
7782
8104
|
"create": false,
|
|
@@ -7802,6 +8124,8 @@
|
|
|
7802
8124
|
"$ref": "#/components/schemas/schemaTrendValue"
|
|
7803
8125
|
}
|
|
7804
8126
|
},
|
|
8127
|
+
"x-f5xc-description-short": "X-displayName: \"Date Aggregation Bucket\" Date histogram bucket containing the timestamp and the number of logs in that bucket.",
|
|
8128
|
+
"x-f5xc-description-medium": "X-displayName: \"Date Aggregation Bucket\" Date histogram bucket containing the timestamp and the number of logs in that bucket.",
|
|
7805
8129
|
"x-f5xc-minimum-configuration": {
|
|
7806
8130
|
"description": "Minimum configuration for logDateAggregationBucket",
|
|
7807
8131
|
"required_fields": [
|
|
@@ -7829,6 +8153,7 @@
|
|
|
7829
8153
|
"items": {
|
|
7830
8154
|
"$ref": "#/components/schemas/logDateAggregationBucket"
|
|
7831
8155
|
},
|
|
8156
|
+
"x-f5xc-description-short": "X-displayName: \"Buckets\" Lists of buckets containing timestamp and the corresponding log count.",
|
|
7832
8157
|
"x-f5xc-required-for": {
|
|
7833
8158
|
"minimum_config": false,
|
|
7834
8159
|
"create": false,
|
|
@@ -7841,6 +8166,8 @@
|
|
|
7841
8166
|
"description": "X-displayName: \"Step\"\nActual step size in the response. It could be higher than the requested step depending on the query duration and/or the log rollups.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
|
|
7842
8167
|
"title": "Step",
|
|
7843
8168
|
"x-f5xc-example": "30m",
|
|
8169
|
+
"x-f5xc-description-short": "X-displayName: \"Step\" Actual step size in the response.",
|
|
8170
|
+
"x-f5xc-description-medium": "X-displayName: \"Step\" Actual step size in the response. It could be higher than the requested step depending on the query duration and/or the log rollups. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
|
|
7844
8171
|
"minLength": 0,
|
|
7845
8172
|
"maxLength": 1024,
|
|
7846
8173
|
"x-f5xc-required-for": {
|
|
@@ -7851,6 +8178,7 @@
|
|
|
7851
8178
|
}
|
|
7852
8179
|
}
|
|
7853
8180
|
},
|
|
8181
|
+
"x-f5xc-description-short": "X-displayName: \"Date Aggregation Data\" Date aggregation data.",
|
|
7854
8182
|
"x-f5xc-minimum-configuration": {
|
|
7855
8183
|
"description": "Minimum configuration for logDateAggregationData",
|
|
7856
8184
|
"required_fields": [
|
|
@@ -7873,6 +8201,8 @@
|
|
|
7873
8201
|
"$ref": "#/components/schemas/logFieldAggregation"
|
|
7874
8202
|
}
|
|
7875
8203
|
},
|
|
8204
|
+
"x-f5xc-description-short": "X-displayName: \"Date SubAggregation\" Aggregate audit logs based on one of the sub aggregation types.",
|
|
8205
|
+
"x-f5xc-description-medium": "X-displayName: \"Date SubAggregation\" Aggregate audit logs based on one of the sub aggregation types.",
|
|
7876
8206
|
"x-f5xc-minimum-configuration": {
|
|
7877
8207
|
"description": "Minimum configuration for logDateSubAggregation",
|
|
7878
8208
|
"required_fields": [
|
|
@@ -7897,6 +8227,7 @@
|
|
|
7897
8227
|
"$ref": "#/components/schemas/logMultiFieldAggregationData"
|
|
7898
8228
|
}
|
|
7899
8229
|
},
|
|
8230
|
+
"x-f5xc-description-short": "X-displayName: \"Date SubAggregation\" Date subaggregation data.",
|
|
7900
8231
|
"x-f5xc-minimum-configuration": {
|
|
7901
8232
|
"description": "Minimum configuration for logDateSubAggregationData",
|
|
7902
8233
|
"required_fields": [
|
|
@@ -7924,6 +8255,8 @@
|
|
|
7924
8255
|
"title": "Topk",
|
|
7925
8256
|
"format": "int64",
|
|
7926
8257
|
"x-f5xc-example": "5",
|
|
8258
|
+
"x-f5xc-description-short": "X-displayName: \"TopK\" Number of top field values to be returned in the response.",
|
|
8259
|
+
"x-f5xc-description-medium": "X-displayName: \"TopK\" Number of top field values to be returned in the response. Optional: If not specified, top 5 values will be returned in the response.",
|
|
7927
8260
|
"minimum": 0,
|
|
7928
8261
|
"maximum": 2147483647,
|
|
7929
8262
|
"x-f5xc-required-for": {
|
|
@@ -7934,6 +8267,7 @@
|
|
|
7934
8267
|
}
|
|
7935
8268
|
}
|
|
7936
8269
|
},
|
|
8270
|
+
"x-f5xc-description-short": "X-displayName: \"Field Aggregation\" Aggregate audit logs based on the key fields in the log.",
|
|
7937
8271
|
"x-f5xc-minimum-configuration": {
|
|
7938
8272
|
"description": "Minimum configuration for logFieldAggregation",
|
|
7939
8273
|
"required_fields": [
|
|
@@ -7957,6 +8291,7 @@
|
|
|
7957
8291
|
"description": "X-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket.",
|
|
7958
8292
|
"title": "Count",
|
|
7959
8293
|
"format": "uint64",
|
|
8294
|
+
"x-f5xc-example": "42",
|
|
7960
8295
|
"minLength": 0,
|
|
7961
8296
|
"maxLength": 1024,
|
|
7962
8297
|
"x-f5xc-required-for": {
|
|
@@ -7981,7 +8316,7 @@
|
|
|
7981
8316
|
},
|
|
7982
8317
|
"x-original-maxLength": 1024,
|
|
7983
8318
|
"x-reconciled-from-discovery": true,
|
|
7984
|
-
"x-reconciled-at": "2026-01-
|
|
8319
|
+
"x-reconciled-at": "2026-01-07T15:28:37.307802+00:00"
|
|
7985
8320
|
},
|
|
7986
8321
|
"order_by": {
|
|
7987
8322
|
"$ref": "#/components/schemas/logOrderByData"
|
|
@@ -7990,6 +8325,7 @@
|
|
|
7990
8325
|
"type": "object",
|
|
7991
8326
|
"description": "X-displayName: \"Sub Aggregation\"\nSub aggregation data for the field aggregation bucket.",
|
|
7992
8327
|
"title": "Sub aggregation.",
|
|
8328
|
+
"x-f5xc-description-short": "X-displayName: \"Sub Aggregation\" Sub aggregation data for the field aggregation bucket.",
|
|
7993
8329
|
"x-f5xc-required-for": {
|
|
7994
8330
|
"minimum_config": false,
|
|
7995
8331
|
"create": false,
|
|
@@ -8001,6 +8337,8 @@
|
|
|
8001
8337
|
"$ref": "#/components/schemas/schemaTrendValue"
|
|
8002
8338
|
}
|
|
8003
8339
|
},
|
|
8340
|
+
"x-f5xc-description-short": "X-displayName: \"Field Aggregation Bucket\" Field aggregation bucket containing field value and the number of logs.",
|
|
8341
|
+
"x-f5xc-description-medium": "X-displayName: \"Field Aggregation Bucket\" Field aggregation bucket containing field value and the number of logs.",
|
|
8004
8342
|
"x-f5xc-minimum-configuration": {
|
|
8005
8343
|
"description": "Minimum configuration for logFieldAggregationBucket",
|
|
8006
8344
|
"required_fields": [
|
|
@@ -8029,6 +8367,7 @@
|
|
|
8029
8367
|
"items": {
|
|
8030
8368
|
"$ref": "#/components/schemas/logFieldAggregationBucket"
|
|
8031
8369
|
},
|
|
8370
|
+
"x-f5xc-description-short": "X-displayName: \"Buckets\" Lists of buckets containing field value and the corresponding log count.",
|
|
8032
8371
|
"x-f5xc-required-for": {
|
|
8033
8372
|
"minimum_config": false,
|
|
8034
8373
|
"create": false,
|
|
@@ -8037,6 +8376,7 @@
|
|
|
8037
8376
|
}
|
|
8038
8377
|
}
|
|
8039
8378
|
},
|
|
8379
|
+
"x-f5xc-description-short": "X-displayName: \"Field Aggregation Data\" Field Aggregation data.",
|
|
8040
8380
|
"x-f5xc-minimum-configuration": {
|
|
8041
8381
|
"description": "Minimum configuration for logFieldAggregationData",
|
|
8042
8382
|
"required_fields": [
|
|
@@ -8059,6 +8399,7 @@
|
|
|
8059
8399
|
"description": "X-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket.",
|
|
8060
8400
|
"title": "Count",
|
|
8061
8401
|
"format": "uint64",
|
|
8402
|
+
"x-f5xc-example": "42",
|
|
8062
8403
|
"minLength": 0,
|
|
8063
8404
|
"maxLength": 1024,
|
|
8064
8405
|
"x-f5xc-required-for": {
|
|
@@ -8073,6 +8414,7 @@
|
|
|
8073
8414
|
"description": "X-displayName: \"Key\"\nKey contain the name/value pair that identifies the unique key fields.",
|
|
8074
8415
|
"title": "Keys",
|
|
8075
8416
|
"x-f5xc-example": "HIT, MISS, REVALIDATED",
|
|
8417
|
+
"x-f5xc-description-short": "X-displayName: \"Key\" Key contain the name/value pair that identifies the unique key fields.",
|
|
8076
8418
|
"minLength": 0,
|
|
8077
8419
|
"maxLength": 16,
|
|
8078
8420
|
"x-f5xc-required-for": {
|
|
@@ -8083,12 +8425,14 @@
|
|
|
8083
8425
|
},
|
|
8084
8426
|
"x-original-maxLength": 1024,
|
|
8085
8427
|
"x-reconciled-from-discovery": true,
|
|
8086
|
-
"x-reconciled-at": "2026-01-
|
|
8428
|
+
"x-reconciled-at": "2026-01-07T15:28:37.307815+00:00"
|
|
8087
8429
|
},
|
|
8088
8430
|
"order_by": {
|
|
8089
8431
|
"$ref": "#/components/schemas/logOrderByData"
|
|
8090
8432
|
}
|
|
8091
8433
|
},
|
|
8434
|
+
"x-f5xc-description-short": "X-displayName: \"Field Sub Aggregation Bucket\" Field sub aggregation bucket containing field values and the number of logs.",
|
|
8435
|
+
"x-f5xc-description-medium": "X-displayName: \"Field Sub Aggregation Bucket\" Field sub aggregation bucket containing field values and the number of logs.",
|
|
8092
8436
|
"x-f5xc-minimum-configuration": {
|
|
8093
8437
|
"description": "Minimum configuration for logFieldSubAggregationBucket",
|
|
8094
8438
|
"required_fields": [
|
|
@@ -8118,6 +8462,7 @@
|
|
|
8118
8462
|
"items": {
|
|
8119
8463
|
"$ref": "#/components/schemas/logFieldSubAggregationBucket"
|
|
8120
8464
|
},
|
|
8465
|
+
"x-f5xc-description-short": "X-displayName: \"Buckets\" Lists of buckets containing field values and the corresponding log count.",
|
|
8121
8466
|
"x-f5xc-required-for": {
|
|
8122
8467
|
"minimum_config": false,
|
|
8123
8468
|
"create": false,
|
|
@@ -8141,6 +8486,7 @@
|
|
|
8141
8486
|
"$ref": "#/components/schemas/logMultiFilterAggregationData"
|
|
8142
8487
|
}
|
|
8143
8488
|
},
|
|
8489
|
+
"x-f5xc-description-short": "X-displayName: \"Field SubAggregation\" Field subaggregation data.",
|
|
8144
8490
|
"x-f5xc-minimum-configuration": {
|
|
8145
8491
|
"description": "Minimum configuration for logFieldSubAggregationData",
|
|
8146
8492
|
"required_fields": [
|
|
@@ -8169,6 +8515,7 @@
|
|
|
8169
8515
|
"description": "X-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket.",
|
|
8170
8516
|
"title": "Count",
|
|
8171
8517
|
"format": "uint64",
|
|
8518
|
+
"x-f5xc-example": "42",
|
|
8172
8519
|
"minLength": 0,
|
|
8173
8520
|
"maxLength": 1024,
|
|
8174
8521
|
"x-f5xc-required-for": {
|
|
@@ -8183,6 +8530,7 @@
|
|
|
8183
8530
|
"description": "X-displayName: \"Key\"\nKey contain the name/value pair that identifies the unique key fields.",
|
|
8184
8531
|
"title": "Keys",
|
|
8185
8532
|
"x-f5xc-example": "HIT, MISS, REVALIDATED",
|
|
8533
|
+
"x-f5xc-description-short": "X-displayName: \"Key\" Key contain the name/value pair that identifies the unique key fields.",
|
|
8186
8534
|
"minLength": 0,
|
|
8187
8535
|
"maxLength": 16,
|
|
8188
8536
|
"x-f5xc-required-for": {
|
|
@@ -8193,9 +8541,11 @@
|
|
|
8193
8541
|
},
|
|
8194
8542
|
"x-original-maxLength": 1024,
|
|
8195
8543
|
"x-reconciled-from-discovery": true,
|
|
8196
|
-
"x-reconciled-at": "2026-01-
|
|
8544
|
+
"x-reconciled-at": "2026-01-07T15:28:37.307830+00:00"
|
|
8197
8545
|
}
|
|
8198
8546
|
},
|
|
8547
|
+
"x-f5xc-description-short": "X-displayName: \"Field Sub Field Aggregation Bucket\" Field sub aggregation bucket containing field values and the number of logs.",
|
|
8548
|
+
"x-f5xc-description-medium": "X-displayName: \"Field Sub Field Aggregation Bucket\" Field sub aggregation bucket containing field values and the number of logs.",
|
|
8199
8549
|
"x-f5xc-minimum-configuration": {
|
|
8200
8550
|
"description": "Minimum configuration for logFieldSubFieldAggregationBucket",
|
|
8201
8551
|
"required_fields": [
|
|
@@ -8221,6 +8571,7 @@
|
|
|
8221
8571
|
"items": {
|
|
8222
8572
|
"$ref": "#/components/schemas/logFieldSubFieldAggregationBucket"
|
|
8223
8573
|
},
|
|
8574
|
+
"x-f5xc-description-short": "X-displayName: \"Buckets\" Lists of buckets containing field value and the corresponding log count.",
|
|
8224
8575
|
"x-f5xc-required-for": {
|
|
8225
8576
|
"minimum_config": false,
|
|
8226
8577
|
"create": false,
|
|
@@ -8229,6 +8580,7 @@
|
|
|
8229
8580
|
}
|
|
8230
8581
|
}
|
|
8231
8582
|
},
|
|
8583
|
+
"x-f5xc-description-short": "X-displayName: \"Field Sub Field Aggregation Data\" Field Aggregation data as Field Sub-aggregation.",
|
|
8232
8584
|
"x-f5xc-minimum-configuration": {
|
|
8233
8585
|
"description": "Minimum configuration for logFieldSubFieldAggregationData",
|
|
8234
8586
|
"required_fields": [
|
|
@@ -8251,6 +8603,7 @@
|
|
|
8251
8603
|
"description": "X-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket.",
|
|
8252
8604
|
"title": "Count",
|
|
8253
8605
|
"format": "uint64",
|
|
8606
|
+
"x-f5xc-example": "42",
|
|
8254
8607
|
"minLength": 0,
|
|
8255
8608
|
"maxLength": 1024,
|
|
8256
8609
|
"x-f5xc-required-for": {
|
|
@@ -8264,6 +8617,7 @@
|
|
|
8264
8617
|
"type": "object",
|
|
8265
8618
|
"description": "X-displayName: \"Sub Aggregation\"\nSub aggregation data for the filter aggregation.",
|
|
8266
8619
|
"title": "Sub aggregation.",
|
|
8620
|
+
"x-f5xc-description-short": "X-displayName: \"Sub Aggregation\" Sub aggregation data for the filter aggregation.",
|
|
8267
8621
|
"x-f5xc-required-for": {
|
|
8268
8622
|
"minimum_config": false,
|
|
8269
8623
|
"create": false,
|
|
@@ -8272,6 +8626,7 @@
|
|
|
8272
8626
|
}
|
|
8273
8627
|
}
|
|
8274
8628
|
},
|
|
8629
|
+
"x-f5xc-description-short": "X-displayName: \"Filter Aggregation Data\" Filter Aggregation Data.",
|
|
8275
8630
|
"x-f5xc-minimum-configuration": {
|
|
8276
8631
|
"description": "Minimum configuration for logFilterAggregationData",
|
|
8277
8632
|
"required_fields": [
|
|
@@ -8297,6 +8652,7 @@
|
|
|
8297
8652
|
"items": {
|
|
8298
8653
|
"$ref": "#/components/schemas/logFilterSubFieldAggregationBucket"
|
|
8299
8654
|
},
|
|
8655
|
+
"x-f5xc-description-short": "X-displayName: \"Buckets\" Lists of buckets containing field value and the corresponding log count.",
|
|
8300
8656
|
"x-f5xc-required-for": {
|
|
8301
8657
|
"minimum_config": false,
|
|
8302
8658
|
"create": false,
|
|
@@ -8305,6 +8661,7 @@
|
|
|
8305
8661
|
}
|
|
8306
8662
|
}
|
|
8307
8663
|
},
|
|
8664
|
+
"x-f5xc-description-short": "X-displayName: \"FilterSubAggregation\" Filter subaggregation data.",
|
|
8308
8665
|
"x-f5xc-minimum-configuration": {
|
|
8309
8666
|
"description": "Minimum configuration for logFilterSubAggregationData",
|
|
8310
8667
|
"required_fields": [
|
|
@@ -8327,6 +8684,7 @@
|
|
|
8327
8684
|
"description": "X-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket.",
|
|
8328
8685
|
"title": "Count",
|
|
8329
8686
|
"format": "uint64",
|
|
8687
|
+
"x-f5xc-example": "42",
|
|
8330
8688
|
"minLength": 0,
|
|
8331
8689
|
"maxLength": 1024,
|
|
8332
8690
|
"x-f5xc-required-for": {
|
|
@@ -8341,6 +8699,7 @@
|
|
|
8341
8699
|
"description": "X-displayName: \"Key\"\nKey contain the name/value pair that identifies the unique key fields.",
|
|
8342
8700
|
"title": "Keys",
|
|
8343
8701
|
"x-f5xc-example": "HIT, MISS, REVALIDATED",
|
|
8702
|
+
"x-f5xc-description-short": "X-displayName: \"Key\" Key contain the name/value pair that identifies the unique key fields.",
|
|
8344
8703
|
"minLength": 0,
|
|
8345
8704
|
"maxLength": 16,
|
|
8346
8705
|
"x-f5xc-required-for": {
|
|
@@ -8351,12 +8710,13 @@
|
|
|
8351
8710
|
},
|
|
8352
8711
|
"x-original-maxLength": 1024,
|
|
8353
8712
|
"x-reconciled-from-discovery": true,
|
|
8354
|
-
"x-reconciled-at": "2026-01-
|
|
8713
|
+
"x-reconciled-at": "2026-01-07T15:28:37.307843+00:00"
|
|
8355
8714
|
},
|
|
8356
8715
|
"sub_aggs": {
|
|
8357
8716
|
"type": "object",
|
|
8358
8717
|
"description": "X-displayName: \"Sub Aggregation\"\nSub aggregation data for the filter aggregation.",
|
|
8359
8718
|
"title": "Sub aggregation.",
|
|
8719
|
+
"x-f5xc-description-short": "X-displayName: \"Sub Aggregation\" Sub aggregation data for the filter aggregation.",
|
|
8360
8720
|
"x-f5xc-required-for": {
|
|
8361
8721
|
"minimum_config": false,
|
|
8362
8722
|
"create": false,
|
|
@@ -8365,6 +8725,8 @@
|
|
|
8365
8725
|
}
|
|
8366
8726
|
}
|
|
8367
8727
|
},
|
|
8728
|
+
"x-f5xc-description-short": "X-displayName: \"Filter Sub Field Aggregation Bucket\" Field sub aggregation bucket containing field values and the number of logs.",
|
|
8729
|
+
"x-f5xc-description-medium": "X-displayName: \"Filter Sub Field Aggregation Bucket\" Field sub aggregation bucket containing field values and the number of logs.",
|
|
8368
8730
|
"x-f5xc-minimum-configuration": {
|
|
8369
8731
|
"description": "Minimum configuration for logFilterSubFieldAggregationBucket",
|
|
8370
8732
|
"required_fields": [
|
|
@@ -8397,6 +8759,8 @@
|
|
|
8397
8759
|
"USER"
|
|
8398
8760
|
],
|
|
8399
8761
|
"default": "ASN",
|
|
8762
|
+
"x-f5xc-description-short": "X-displayName: \"Key Field\" Fields that can be specified in the field aggregation. - ASN: x-displayName: \"ASN number\" - AUTHOR_TENANT...",
|
|
8763
|
+
"x-f5xc-description-medium": "X-displayName: \"Key Field\" Fields that can be specified in the field aggregation. - ASN: x-displayName: \"ASN number\" - AUTHOR_TENANT: x-displayName: \"Author Tenant\" - BROWSER_TYPE: x-displayName: \"Browser Type\" - CITY: x-displayName: \"City\" - COUNTRY: x-displayName: \"Country\" - DEVICE_TYPE...",
|
|
8400
8764
|
"x-f5xc-minimum-configuration": {
|
|
8401
8765
|
"description": "Minimum configuration for logKeyField",
|
|
8402
8766
|
"required_fields": [],
|
|
@@ -8443,6 +8807,7 @@
|
|
|
8443
8807
|
"$ref": "#/components/schemas/logMultiFilterAggregationData"
|
|
8444
8808
|
}
|
|
8445
8809
|
},
|
|
8810
|
+
"x-f5xc-description-short": "X-displayName: \"Log Aggregation\" Log aggregation response data.",
|
|
8446
8811
|
"x-f5xc-minimum-configuration": {
|
|
8447
8812
|
"description": "Minimum configuration for logLogAggregationData",
|
|
8448
8813
|
"required_fields": [
|
|
@@ -8483,9 +8848,10 @@
|
|
|
8483
8848
|
"maxLength": 15,
|
|
8484
8849
|
"minLength": 3,
|
|
8485
8850
|
"x-reconciled-from-discovery": true,
|
|
8486
|
-
"x-reconciled-at": "2026-01-
|
|
8851
|
+
"x-reconciled-at": "2026-01-07T15:28:37.307861+00:00"
|
|
8487
8852
|
}
|
|
8488
8853
|
},
|
|
8854
|
+
"x-f5xc-description-short": "X-displayName: \"Max Aggregation Data\" Max Aggregation data.",
|
|
8489
8855
|
"x-f5xc-minimum-configuration": {
|
|
8490
8856
|
"description": "Minimum configuration for logMaxAggregationData",
|
|
8491
8857
|
"required_fields": [
|
|
@@ -8507,6 +8873,7 @@
|
|
|
8507
8873
|
"$ref": "#/components/schemas/logPercentileAggregationData"
|
|
8508
8874
|
}
|
|
8509
8875
|
},
|
|
8876
|
+
"x-f5xc-description-short": "X-displayName: \"Metrics Aggregation\" Metrics aggregation data.",
|
|
8510
8877
|
"x-f5xc-minimum-configuration": {
|
|
8511
8878
|
"description": "Minimum configuration for logMetricsAggregationData",
|
|
8512
8879
|
"required_fields": [
|
|
@@ -8538,9 +8905,10 @@
|
|
|
8538
8905
|
"maxLength": 15,
|
|
8539
8906
|
"minLength": 3,
|
|
8540
8907
|
"x-reconciled-from-discovery": true,
|
|
8541
|
-
"x-reconciled-at": "2026-01-
|
|
8908
|
+
"x-reconciled-at": "2026-01-07T15:28:37.307868+00:00"
|
|
8542
8909
|
}
|
|
8543
8910
|
},
|
|
8911
|
+
"x-f5xc-description-short": "X-displayName: \"Min Aggregation Data\" Min Aggregation data.",
|
|
8544
8912
|
"x-f5xc-minimum-configuration": {
|
|
8545
8913
|
"description": "Minimum configuration for logMinAggregationData",
|
|
8546
8914
|
"required_fields": [
|
|
@@ -8563,6 +8931,7 @@
|
|
|
8563
8931
|
"description": "X-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket.",
|
|
8564
8932
|
"title": "Count",
|
|
8565
8933
|
"format": "uint64",
|
|
8934
|
+
"x-f5xc-example": "42",
|
|
8566
8935
|
"minLength": 0,
|
|
8567
8936
|
"maxLength": 1024,
|
|
8568
8937
|
"x-f5xc-required-for": {
|
|
@@ -8577,6 +8946,8 @@
|
|
|
8577
8946
|
"description": "X-displayName: \"Keys\"\nKeys contain the name/value pair that identifies the unique combination of multiple key fields\nSRC_IP\": \"10.10.10.1\", \"COUNTRY\": \"US\"}\"",
|
|
8578
8947
|
"title": "Keys",
|
|
8579
8948
|
"x-f5xc-example": "{",
|
|
8949
|
+
"x-f5xc-description-short": "X-displayName: \"Keys\" Keys contain the name/value pair that identifies the unique combination of multiple key fields SRC_IP\": \"10.10.10.1\"...",
|
|
8950
|
+
"x-f5xc-description-medium": "X-displayName: \"Keys\" Keys contain the name/value pair that identifies the unique combination of multiple key fields SRC_IP\": \"10.10.10.1\", \"COUNTRY\": \"US\"}\".",
|
|
8580
8951
|
"x-f5xc-required-for": {
|
|
8581
8952
|
"minimum_config": false,
|
|
8582
8953
|
"create": false,
|
|
@@ -8591,6 +8962,7 @@
|
|
|
8591
8962
|
"type": "object",
|
|
8592
8963
|
"description": "X-displayName: \"Sub Aggregation\"\nSub aggregation data for the multi field aggregation bucket.",
|
|
8593
8964
|
"title": "Sub aggregation.",
|
|
8965
|
+
"x-f5xc-description-short": "X-displayName: \"Sub Aggregation\" Sub aggregation data for the multi field aggregation bucket.",
|
|
8594
8966
|
"x-f5xc-required-for": {
|
|
8595
8967
|
"minimum_config": false,
|
|
8596
8968
|
"create": false,
|
|
@@ -8599,6 +8971,8 @@
|
|
|
8599
8971
|
}
|
|
8600
8972
|
}
|
|
8601
8973
|
},
|
|
8974
|
+
"x-f5xc-description-short": "X-displayName: \"Multi-Field Aggregation Bucket\" Multi-Field aggregation bucket containing field values and the number of logs.",
|
|
8975
|
+
"x-f5xc-description-medium": "X-displayName: \"Multi-Field Aggregation Bucket\" Multi-Field aggregation bucket containing field values and the number of logs.",
|
|
8602
8976
|
"x-f5xc-minimum-configuration": {
|
|
8603
8977
|
"description": "Minimum configuration for logMultiFieldAggregationBucket",
|
|
8604
8978
|
"required_fields": [
|
|
@@ -8626,6 +9000,7 @@
|
|
|
8626
9000
|
"items": {
|
|
8627
9001
|
"$ref": "#/components/schemas/logMultiFieldAggregationBucket"
|
|
8628
9002
|
},
|
|
9003
|
+
"x-f5xc-description-short": "X-displayName: \"Buckets\" Lists of buckets containing field values and the corresponding log count.",
|
|
8629
9004
|
"x-f5xc-required-for": {
|
|
8630
9005
|
"minimum_config": false,
|
|
8631
9006
|
"create": false,
|
|
@@ -8634,6 +9009,7 @@
|
|
|
8634
9009
|
}
|
|
8635
9010
|
}
|
|
8636
9011
|
},
|
|
9012
|
+
"x-f5xc-description-short": "X-displayName: \"Multi-Field Aggregation Data\" Multi-Field Aggregation data.",
|
|
8637
9013
|
"x-f5xc-minimum-configuration": {
|
|
8638
9014
|
"description": "Minimum configuration for logMultiFieldAggregationData",
|
|
8639
9015
|
"required_fields": [
|
|
@@ -8667,6 +9043,7 @@
|
|
|
8667
9043
|
"$ref": "#/components/schemas/logTopHitsAggregationData"
|
|
8668
9044
|
}
|
|
8669
9045
|
},
|
|
9046
|
+
"x-f5xc-description-short": "X-displayName: \"Multi Field SubAggregation\" Field subaggregation data.",
|
|
8670
9047
|
"x-f5xc-minimum-configuration": {
|
|
8671
9048
|
"description": "Minimum configuration for logMultiFieldSubAggregationData",
|
|
8672
9049
|
"required_fields": [
|
|
@@ -8693,6 +9070,7 @@
|
|
|
8693
9070
|
"description": "X-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket.",
|
|
8694
9071
|
"title": "Count",
|
|
8695
9072
|
"format": "uint64",
|
|
9073
|
+
"x-f5xc-example": "42",
|
|
8696
9074
|
"minLength": 0,
|
|
8697
9075
|
"maxLength": 1024,
|
|
8698
9076
|
"x-f5xc-required-for": {
|
|
@@ -8703,6 +9081,7 @@
|
|
|
8703
9081
|
}
|
|
8704
9082
|
}
|
|
8705
9083
|
},
|
|
9084
|
+
"x-f5xc-description-short": "X-displayName: \"Multi Filter Aggregation Data\" Multi Filter Aggregation data.",
|
|
8706
9085
|
"x-f5xc-minimum-configuration": {
|
|
8707
9086
|
"description": "Minimum configuration for logMultiFilterAggregationData",
|
|
8708
9087
|
"required_fields": [
|
|
@@ -8724,6 +9103,7 @@
|
|
|
8724
9103
|
"$ref": "#/components/schemas/logMetricsAggregationData"
|
|
8725
9104
|
}
|
|
8726
9105
|
},
|
|
9106
|
+
"x-f5xc-description-short": "X-displayName: \"Order by Data\" Order by data.",
|
|
8727
9107
|
"x-f5xc-minimum-configuration": {
|
|
8728
9108
|
"description": "Minimum configuration for logOrderByData",
|
|
8729
9109
|
"required_fields": [
|
|
@@ -8746,6 +9126,7 @@
|
|
|
8746
9126
|
"description": "X-displayName: \"Key\"\nx-example: 99.0.",
|
|
8747
9127
|
"title": "Key",
|
|
8748
9128
|
"format": "double",
|
|
9129
|
+
"x-f5xc-example": "[REDACTED_PUBLIC_KEY]",
|
|
8749
9130
|
"x-f5xc-required-for": {
|
|
8750
9131
|
"minimum_config": false,
|
|
8751
9132
|
"create": false,
|
|
@@ -8755,7 +9136,7 @@
|
|
|
8755
9136
|
"maxLength": 16,
|
|
8756
9137
|
"minLength": 7,
|
|
8757
9138
|
"x-reconciled-from-discovery": true,
|
|
8758
|
-
"x-reconciled-at": "2026-01-
|
|
9139
|
+
"x-reconciled-at": "2026-01-07T15:28:37.307890+00:00"
|
|
8759
9140
|
},
|
|
8760
9141
|
"value": {
|
|
8761
9142
|
"type": "number",
|
|
@@ -8771,9 +9152,10 @@
|
|
|
8771
9152
|
"maxLength": 15,
|
|
8772
9153
|
"minLength": 3,
|
|
8773
9154
|
"x-reconciled-from-discovery": true,
|
|
8774
|
-
"x-reconciled-at": "2026-01-
|
|
9155
|
+
"x-reconciled-at": "2026-01-07T15:28:37.307895+00:00"
|
|
8775
9156
|
}
|
|
8776
9157
|
},
|
|
9158
|
+
"x-f5xc-description-short": "X-displayName: \"Percentile Aggregation Data\" Percentile Aggregation data.",
|
|
8777
9159
|
"x-f5xc-minimum-configuration": {
|
|
8778
9160
|
"description": "Minimum configuration for logPercentileAggregationData",
|
|
8779
9161
|
"required_fields": [
|
|
@@ -8797,6 +9179,7 @@
|
|
|
8797
9179
|
"description": "X-displayName: \"Count\"\nx-example: 100\nCount of top hit values.",
|
|
8798
9180
|
"title": "Count",
|
|
8799
9181
|
"format": "uint64",
|
|
9182
|
+
"x-f5xc-example": "42",
|
|
8800
9183
|
"minLength": 0,
|
|
8801
9184
|
"maxLength": 1024,
|
|
8802
9185
|
"x-f5xc-required-for": {
|
|
@@ -8813,6 +9196,7 @@
|
|
|
8813
9196
|
"items": {
|
|
8814
9197
|
"type": "string"
|
|
8815
9198
|
},
|
|
9199
|
+
"x-f5xc-description-short": "X-displayName: \"Documents\" document values.",
|
|
8816
9200
|
"x-f5xc-required-for": {
|
|
8817
9201
|
"minimum_config": false,
|
|
8818
9202
|
"create": false,
|
|
@@ -8821,6 +9205,7 @@
|
|
|
8821
9205
|
}
|
|
8822
9206
|
}
|
|
8823
9207
|
},
|
|
9208
|
+
"x-f5xc-description-short": "X-displayName: \"TopHits Aggregation Data\" Top Hits Aggregation Data.",
|
|
8824
9209
|
"x-f5xc-minimum-configuration": {
|
|
8825
9210
|
"description": "Minimum configuration for logTopHitsAggregationData",
|
|
8826
9211
|
"required_fields": [
|
|
@@ -8860,6 +9245,8 @@
|
|
|
8860
9245
|
}
|
|
8861
9246
|
}
|
|
8862
9247
|
},
|
|
9248
|
+
"x-f5xc-description-short": "VoltShareAccessCounter contains the access count for each unique combination of group_by label in the request.",
|
|
9249
|
+
"x-f5xc-description-medium": "VoltShareAccessCounter contains the access count for each unique combination of group_by label in the request.",
|
|
8863
9250
|
"x-f5xc-minimum-configuration": {
|
|
8864
9251
|
"description": "Minimum configuration for metricsVoltShareAccessCounter",
|
|
8865
9252
|
"required_fields": [
|
|
@@ -8887,6 +9274,7 @@
|
|
|
8887
9274
|
"x-displayname": "Country",
|
|
8888
9275
|
"x-ves-example": "US",
|
|
8889
9276
|
"x-f5xc-example": "US",
|
|
9277
|
+
"x-f5xc-description-short": "Country from where the API call was made.",
|
|
8890
9278
|
"minLength": 0,
|
|
8891
9279
|
"maxLength": 1024,
|
|
8892
9280
|
"x-f5xc-required-for": {
|
|
@@ -8935,6 +9323,7 @@
|
|
|
8935
9323
|
"x-displayname": "User Tenant.",
|
|
8936
9324
|
"x-ves-example": "Customer1",
|
|
8937
9325
|
"x-f5xc-example": "customer1",
|
|
9326
|
+
"x-f5xc-description-short": "Tenant that made the VoltShare API call.",
|
|
8938
9327
|
"minLength": 0,
|
|
8939
9328
|
"maxLength": 1024,
|
|
8940
9329
|
"x-f5xc-required-for": {
|
|
@@ -8945,6 +9334,8 @@
|
|
|
8945
9334
|
}
|
|
8946
9335
|
}
|
|
8947
9336
|
},
|
|
9337
|
+
"x-f5xc-description-short": "VoltShareAccessId uniquely identifies an entry in the response.",
|
|
9338
|
+
"x-f5xc-description-medium": "VoltShareAccessId uniquely identifies an entry in the response. VoltShare access count is aggregated based on the MetricLabel specified in the group_by field in the request. Therefore, only the fields that corresponds to the MetricLabel in the group_by will have non-empty value in the response.",
|
|
8948
9339
|
"x-f5xc-minimum-configuration": {
|
|
8949
9340
|
"description": "Minimum configuration for metricsVoltShareAccessId",
|
|
8950
9341
|
"required_fields": [
|
|
@@ -8973,6 +9364,7 @@
|
|
|
8973
9364
|
"default": "OPERATION",
|
|
8974
9365
|
"x-displayname": "VoltShare Access Metric Labels.",
|
|
8975
9366
|
"x-ves-proto-enum": "ves.io.schema.voltshare.metrics.VoltShareMetricLabel",
|
|
9367
|
+
"x-f5xc-description-short": "VoltShare Access metric can be sliced and diced based on one or more labels listed below.",
|
|
8976
9368
|
"x-f5xc-minimum-configuration": {
|
|
8977
9369
|
"description": "Minimum configuration for metricsVoltShareMetricLabel",
|
|
8978
9370
|
"required_fields": [],
|
|
@@ -9013,9 +9405,11 @@
|
|
|
9013
9405
|
},
|
|
9014
9406
|
"x-original-maxLength": 1024,
|
|
9015
9407
|
"x-reconciled-from-discovery": true,
|
|
9016
|
-
"x-reconciled-at": "2026-01-
|
|
9408
|
+
"x-reconciled-at": "2026-01-07T15:28:37.307914+00:00"
|
|
9017
9409
|
}
|
|
9018
9410
|
},
|
|
9411
|
+
"x-f5xc-description-short": "VoltShare Access metric is tagged with labels mentioned in MetricLabel.",
|
|
9412
|
+
"x-f5xc-description-medium": "VoltShare Access metric is tagged with labels mentioned in MetricLabel. Metric label filter can be specified to query/aggregate specific timeseries based on label match.",
|
|
9019
9413
|
"x-f5xc-minimum-configuration": {
|
|
9020
9414
|
"description": "Minimum configuration for metricsVoltShareMetricLabelFilter",
|
|
9021
9415
|
"required_fields": [
|
|
@@ -9041,6 +9435,7 @@
|
|
|
9041
9435
|
"default": "EQ",
|
|
9042
9436
|
"x-displayname": "VoltShare Access Metric Label Operator.",
|
|
9043
9437
|
"x-ves-proto-enum": "ves.io.schema.voltshare.metrics.VoltShareMetricLabelOp",
|
|
9438
|
+
"x-f5xc-description-short": "The operator to use when querying VoltShare Access metrics with labels.",
|
|
9044
9439
|
"x-f5xc-minimum-configuration": {
|
|
9045
9440
|
"description": "Minimum configuration for metricsVoltShareMetricLabelOp",
|
|
9046
9441
|
"required_fields": [],
|
|
@@ -9090,9 +9485,10 @@
|
|
|
9090
9485
|
},
|
|
9091
9486
|
"x-original-maxLength": 1024,
|
|
9092
9487
|
"x-reconciled-from-discovery": true,
|
|
9093
|
-
"x-reconciled-at": "2026-01-
|
|
9488
|
+
"x-reconciled-at": "2026-01-07T15:28:37.307921+00:00"
|
|
9094
9489
|
}
|
|
9095
9490
|
},
|
|
9491
|
+
"x-f5xc-description-short": "Value returned for a VoltShare Access Metrics query.",
|
|
9096
9492
|
"x-f5xc-minimum-configuration": {
|
|
9097
9493
|
"description": "Minimum configuration for metricsVoltShareMetricValue",
|
|
9098
9494
|
"required_fields": [
|
|
@@ -9117,6 +9513,7 @@
|
|
|
9117
9513
|
"default": "DESCENDING",
|
|
9118
9514
|
"x-displayname": "Sort Order.",
|
|
9119
9515
|
"x-ves-proto-enum": "ves.io.schema.SortOrder",
|
|
9516
|
+
"x-f5xc-description-short": "Sort algorithm Sort in descending order Sort in ascending order.",
|
|
9120
9517
|
"x-f5xc-minimum-configuration": {
|
|
9121
9518
|
"description": "Minimum configuration for schemaSortOrder",
|
|
9122
9519
|
"required_fields": [],
|
|
@@ -9137,6 +9534,8 @@
|
|
|
9137
9534
|
"TREND_SENTIMENT_NEGATIVE"
|
|
9138
9535
|
],
|
|
9139
9536
|
"default": "TREND_SENTIMENT_NONE",
|
|
9537
|
+
"x-f5xc-description-short": "X-displayName: \"Trend Sentiment\" trend sentiment - TREND_SENTIMENT_NONE: x-displayName: \"None\" - TREND_SENTIMENT_POSITIVE: x-displayName...",
|
|
9538
|
+
"x-f5xc-description-medium": "X-displayName: \"Trend Sentiment\" trend sentiment - TREND_SENTIMENT_NONE: x-displayName: \"None\" - TREND_SENTIMENT_POSITIVE: x-displayName: \"Positive\" Indicates trend sentiment is positive - TREND_SENTIMENT_NEGATIVE: x-displayName: \"Negative\" Indicates trend sentiment is negative.",
|
|
9140
9539
|
"x-f5xc-minimum-configuration": {
|
|
9141
9540
|
"description": "Minimum configuration for schemaTrendSentiment",
|
|
9142
9541
|
"required_fields": [],
|
|
@@ -9157,6 +9556,7 @@
|
|
|
9157
9556
|
"description": "X-displayName: \"Description\"\ndescription of the method used to calculate trend.",
|
|
9158
9557
|
"title": "Description.",
|
|
9159
9558
|
"x-f5xc-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval",
|
|
9559
|
+
"x-f5xc-description-short": "X-displayName: \"Description\" description of the method used to calculate trend.",
|
|
9160
9560
|
"minLength": 0,
|
|
9161
9561
|
"maxLength": 0,
|
|
9162
9562
|
"x-f5xc-required-for": {
|
|
@@ -9167,7 +9567,7 @@
|
|
|
9167
9567
|
},
|
|
9168
9568
|
"x-original-maxLength": 1024,
|
|
9169
9569
|
"x-reconciled-from-discovery": true,
|
|
9170
|
-
"x-reconciled-at": "2026-01-
|
|
9570
|
+
"x-reconciled-at": "2026-01-07T15:28:37.307926+00:00"
|
|
9171
9571
|
},
|
|
9172
9572
|
"previous_value": {
|
|
9173
9573
|
"type": "string",
|
|
@@ -9201,9 +9601,11 @@
|
|
|
9201
9601
|
},
|
|
9202
9602
|
"x-original-maxLength": 1024,
|
|
9203
9603
|
"x-reconciled-from-discovery": true,
|
|
9204
|
-
"x-reconciled-at": "2026-01-
|
|
9604
|
+
"x-reconciled-at": "2026-01-07T15:28:37.307933+00:00"
|
|
9205
9605
|
}
|
|
9206
9606
|
},
|
|
9607
|
+
"x-f5xc-description-short": "X-displayName: \"Trend Value\" Trend value contains trend value, trend sentiment and trend calculation description and window size.",
|
|
9608
|
+
"x-f5xc-description-medium": "X-displayName: \"Trend Value\" Trend value contains trend value, trend sentiment and trend calculation description and window size.",
|
|
9207
9609
|
"x-f5xc-minimum-configuration": {
|
|
9208
9610
|
"description": "Minimum configuration for schemaTrendValue",
|
|
9209
9611
|
"required_fields": [
|
|
@@ -9231,6 +9633,8 @@
|
|
|
9231
9633
|
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are keyed by user-defined aggregation name. The response will be keyed with the same name.\nOptional.",
|
|
9232
9634
|
"title": "Aggregations.",
|
|
9233
9635
|
"x-displayname": "Aggregations.",
|
|
9636
|
+
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
|
|
9637
|
+
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are keyed by user-defined aggregation name.",
|
|
9234
9638
|
"x-f5xc-required-for": {
|
|
9235
9639
|
"minimum_config": false,
|
|
9236
9640
|
"create": false,
|
|
@@ -9251,6 +9655,8 @@
|
|
|
9251
9655
|
"x-validation-rules": {
|
|
9252
9656
|
"ves.io.schema.rules.string.query_time": "true"
|
|
9253
9657
|
},
|
|
9658
|
+
"x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
|
|
9659
|
+
"x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
|
|
9254
9660
|
"minLength": 0,
|
|
9255
9661
|
"maxLength": 1024,
|
|
9256
9662
|
"x-f5xc-required-for": {
|
|
@@ -9267,6 +9673,7 @@
|
|
|
9267
9673
|
"x-displayname": "Namespace",
|
|
9268
9674
|
"x-ves-example": "Value",
|
|
9269
9675
|
"x-f5xc-example": "value",
|
|
9676
|
+
"x-f5xc-description-short": "Fetch aggregation data scoped by namespace.",
|
|
9270
9677
|
"minLength": 0,
|
|
9271
9678
|
"maxLength": 6,
|
|
9272
9679
|
"x-f5xc-required-for": {
|
|
@@ -9277,7 +9684,7 @@
|
|
|
9277
9684
|
},
|
|
9278
9685
|
"x-original-maxLength": 1024,
|
|
9279
9686
|
"x-reconciled-from-discovery": true,
|
|
9280
|
-
"x-reconciled-at": "2026-01-
|
|
9687
|
+
"x-reconciled-at": "2026-01-07T15:28:37.307941+00:00"
|
|
9281
9688
|
},
|
|
9282
9689
|
"query": {
|
|
9283
9690
|
"type": "string",
|
|
@@ -9286,6 +9693,8 @@
|
|
|
9286
9693
|
"x-displayname": "Query",
|
|
9287
9694
|
"x-ves-example": "{user=\\\"abc@xyz.com\\\"}",
|
|
9288
9695
|
"x-f5xc-example": "\"{user=\\\"abc@xyz.com\\\"}\"",
|
|
9696
|
+
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
|
|
9697
|
+
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of the following fields in audit log may be specified in the query. User - user name src_ip - source IP address secret_name - secret...",
|
|
9289
9698
|
"minLength": 0,
|
|
9290
9699
|
"maxLength": 1024,
|
|
9291
9700
|
"x-f5xc-required-for": {
|
|
@@ -9308,6 +9717,8 @@
|
|
|
9308
9717
|
"x-validation-rules": {
|
|
9309
9718
|
"ves.io.schema.rules.string.query_time": "true"
|
|
9310
9719
|
},
|
|
9720
|
+
"x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
|
|
9721
|
+
"x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
|
|
9311
9722
|
"minLength": 0,
|
|
9312
9723
|
"maxLength": 1024,
|
|
9313
9724
|
"x-f5xc-required-for": {
|
|
@@ -9318,6 +9729,7 @@
|
|
|
9318
9729
|
}
|
|
9319
9730
|
}
|
|
9320
9731
|
},
|
|
9732
|
+
"x-f5xc-description-short": "Request to GET only aggregation data for audit logs.",
|
|
9321
9733
|
"x-f5xc-minimum-configuration": {
|
|
9322
9734
|
"description": "Minimum configuration for voltshareAuditLogAggregationRequest",
|
|
9323
9735
|
"required_fields": [
|
|
@@ -9346,6 +9758,8 @@
|
|
|
9346
9758
|
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is keyed with the aggregation name specified in the request.",
|
|
9347
9759
|
"title": "Aggregations.",
|
|
9348
9760
|
"x-displayname": "Aggregations.",
|
|
9761
|
+
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
|
|
9762
|
+
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregation data is keyed with the aggregation name...",
|
|
9349
9763
|
"x-f5xc-required-for": {
|
|
9350
9764
|
"minimum_config": false,
|
|
9351
9765
|
"create": false,
|
|
@@ -9361,6 +9775,7 @@
|
|
|
9361
9775
|
"x-displayname": "Total Hits.",
|
|
9362
9776
|
"x-ves-example": "0",
|
|
9363
9777
|
"x-f5xc-example": "0",
|
|
9778
|
+
"x-f5xc-description-short": "Total number of log messages that matched the query.",
|
|
9364
9779
|
"minLength": 0,
|
|
9365
9780
|
"maxLength": 1024,
|
|
9366
9781
|
"x-f5xc-required-for": {
|
|
@@ -9371,6 +9786,7 @@
|
|
|
9371
9786
|
}
|
|
9372
9787
|
}
|
|
9373
9788
|
},
|
|
9789
|
+
"x-f5xc-description-short": "Response message for AuditLogAggregationRequest.",
|
|
9374
9790
|
"x-f5xc-minimum-configuration": {
|
|
9375
9791
|
"description": "Minimum configuration for voltshareAuditLogAggregationResponse",
|
|
9376
9792
|
"required_fields": [
|
|
@@ -9396,6 +9812,8 @@
|
|
|
9396
9812
|
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are keyed by user-defined aggregation name. The response will be keyed with the same name.\nOptional.",
|
|
9397
9813
|
"title": "Aggregations.",
|
|
9398
9814
|
"x-displayname": "Aggregations.",
|
|
9815
|
+
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
|
|
9816
|
+
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are keyed by user-defined aggregation name.",
|
|
9399
9817
|
"x-f5xc-required-for": {
|
|
9400
9818
|
"minimum_config": false,
|
|
9401
9819
|
"create": false,
|
|
@@ -9416,6 +9834,8 @@
|
|
|
9416
9834
|
"x-validation-rules": {
|
|
9417
9835
|
"ves.io.schema.rules.string.query_time": "true"
|
|
9418
9836
|
},
|
|
9837
|
+
"x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
|
|
9838
|
+
"x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
|
|
9419
9839
|
"minLength": 0,
|
|
9420
9840
|
"maxLength": 1024,
|
|
9421
9841
|
"x-f5xc-required-for": {
|
|
@@ -9433,6 +9853,8 @@
|
|
|
9433
9853
|
"x-displayname": "Limit",
|
|
9434
9854
|
"x-ves-example": "0",
|
|
9435
9855
|
"x-f5xc-example": "0",
|
|
9856
|
+
"x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on...",
|
|
9857
|
+
"x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.",
|
|
9436
9858
|
"minimum": 0,
|
|
9437
9859
|
"maximum": 2147483647,
|
|
9438
9860
|
"x-f5xc-required-for": {
|
|
@@ -9449,6 +9871,7 @@
|
|
|
9449
9871
|
"x-displayname": "Namespace",
|
|
9450
9872
|
"x-ves-example": "Value",
|
|
9451
9873
|
"x-f5xc-example": "value",
|
|
9874
|
+
"x-f5xc-description-short": "Fetch the log messages scoped by namespace.",
|
|
9452
9875
|
"minLength": 0,
|
|
9453
9876
|
"maxLength": 6,
|
|
9454
9877
|
"x-f5xc-required-for": {
|
|
@@ -9459,7 +9882,7 @@
|
|
|
9459
9882
|
},
|
|
9460
9883
|
"x-original-maxLength": 1024,
|
|
9461
9884
|
"x-reconciled-from-discovery": true,
|
|
9462
|
-
"x-reconciled-at": "2026-01-
|
|
9885
|
+
"x-reconciled-at": "2026-01-07T15:28:37.307957+00:00"
|
|
9463
9886
|
},
|
|
9464
9887
|
"query": {
|
|
9465
9888
|
"type": "string",
|
|
@@ -9468,6 +9891,8 @@
|
|
|
9468
9891
|
"x-displayname": "Query",
|
|
9469
9892
|
"x-ves-example": "{user=\\\"abc@xyz.com\\\"}",
|
|
9470
9893
|
"x-f5xc-example": "\"{user=\\\"abc@xyz.com\\\"}\"",
|
|
9894
|
+
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
|
|
9895
|
+
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of the following fields in audit log may be specified in the query. User - user name src_ip - source IP address secret_name - secret...",
|
|
9471
9896
|
"minLength": 0,
|
|
9472
9897
|
"maxLength": 1024,
|
|
9473
9898
|
"x-f5xc-required-for": {
|
|
@@ -9485,6 +9910,8 @@
|
|
|
9485
9910
|
"x-displayname": "Scroll",
|
|
9486
9911
|
"x-ves-example": "True",
|
|
9487
9912
|
"x-f5xc-example": "true",
|
|
9913
|
+
"x-f5xc-description-short": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.",
|
|
9914
|
+
"x-f5xc-description-medium": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of logs until there are no more logs left to return. The number of messages in each...",
|
|
9488
9915
|
"x-f5xc-required-for": {
|
|
9489
9916
|
"minimum_config": false,
|
|
9490
9917
|
"create": false,
|
|
@@ -9508,6 +9935,8 @@
|
|
|
9508
9935
|
"x-validation-rules": {
|
|
9509
9936
|
"ves.io.schema.rules.string.query_time": "true"
|
|
9510
9937
|
},
|
|
9938
|
+
"x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
|
|
9939
|
+
"x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
|
|
9511
9940
|
"minLength": 0,
|
|
9512
9941
|
"maxLength": 1024,
|
|
9513
9942
|
"x-f5xc-required-for": {
|
|
@@ -9549,6 +9978,8 @@
|
|
|
9549
9978
|
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is keyed with the aggregation name specified in the request.",
|
|
9550
9979
|
"title": "Aggregations.",
|
|
9551
9980
|
"x-displayname": "Aggregations.",
|
|
9981
|
+
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
|
|
9982
|
+
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregation data is keyed with the aggregation name...",
|
|
9552
9983
|
"x-f5xc-required-for": {
|
|
9553
9984
|
"minimum_config": false,
|
|
9554
9985
|
"create": false,
|
|
@@ -9566,6 +9997,8 @@
|
|
|
9566
9997
|
"x-displayname": "Logs",
|
|
9567
9998
|
"x-ves-example": "Value",
|
|
9568
9999
|
"x-f5xc-example": "value",
|
|
10000
|
+
"x-f5xc-description-short": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response.",
|
|
10001
|
+
"x-f5xc-description-medium": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response.",
|
|
9569
10002
|
"x-f5xc-required-for": {
|
|
9570
10003
|
"minimum_config": false,
|
|
9571
10004
|
"create": false,
|
|
@@ -9580,6 +10013,8 @@
|
|
|
9580
10013
|
"x-displayname": "Scroll ID",
|
|
9581
10014
|
"x-ves-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==.",
|
|
9582
10015
|
"x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==",
|
|
10016
|
+
"x-f5xc-description-short": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.",
|
|
10017
|
+
"x-f5xc-description-medium": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request. Empty scroll_id indicates no more messages to scroll (EOF).",
|
|
9583
10018
|
"minLength": 0,
|
|
9584
10019
|
"maxLength": 1024,
|
|
9585
10020
|
"x-f5xc-required-for": {
|
|
@@ -9598,6 +10033,7 @@
|
|
|
9598
10033
|
"x-displayname": "Total Hits.",
|
|
9599
10034
|
"x-ves-example": "0",
|
|
9600
10035
|
"x-f5xc-example": "0",
|
|
10036
|
+
"x-f5xc-description-short": "Total number of log messages that matched the query.",
|
|
9601
10037
|
"minLength": 0,
|
|
9602
10038
|
"maxLength": 1024,
|
|
9603
10039
|
"x-f5xc-required-for": {
|
|
@@ -9608,6 +10044,7 @@
|
|
|
9608
10044
|
}
|
|
9609
10045
|
}
|
|
9610
10046
|
},
|
|
10047
|
+
"x-f5xc-description-short": "Response message for AuditLogRequest/LogScrollRequest.",
|
|
9611
10048
|
"x-f5xc-minimum-configuration": {
|
|
9612
10049
|
"description": "Minimum configuration for voltshareAuditLogResponse",
|
|
9613
10050
|
"required_fields": [
|
|
@@ -9637,6 +10074,7 @@
|
|
|
9637
10074
|
"x-displayname": "Namespace",
|
|
9638
10075
|
"x-ves-example": "Value",
|
|
9639
10076
|
"x-f5xc-example": "value",
|
|
10077
|
+
"x-f5xc-description-short": "Fetch the log messages scoped by namespace.",
|
|
9640
10078
|
"minLength": 0,
|
|
9641
10079
|
"maxLength": 6,
|
|
9642
10080
|
"x-f5xc-required-for": {
|
|
@@ -9647,7 +10085,7 @@
|
|
|
9647
10085
|
},
|
|
9648
10086
|
"x-original-maxLength": 1024,
|
|
9649
10087
|
"x-reconciled-from-discovery": true,
|
|
9650
|
-
"x-reconciled-at": "2026-01-
|
|
10088
|
+
"x-reconciled-at": "2026-01-07T15:28:37.307973+00:00"
|
|
9651
10089
|
},
|
|
9652
10090
|
"scroll_id": {
|
|
9653
10091
|
"type": "string",
|
|
@@ -9656,6 +10094,7 @@
|
|
|
9656
10094
|
"x-displayname": "Scroll ID",
|
|
9657
10095
|
"x-ves-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==.",
|
|
9658
10096
|
"x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==",
|
|
10097
|
+
"x-f5xc-description-short": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.",
|
|
9659
10098
|
"minLength": 0,
|
|
9660
10099
|
"maxLength": 1024,
|
|
9661
10100
|
"x-f5xc-required-for": {
|
|
@@ -9667,6 +10106,8 @@
|
|
|
9667
10106
|
"x-field-mutability": "read-only"
|
|
9668
10107
|
}
|
|
9669
10108
|
},
|
|
10109
|
+
"x-f5xc-description-short": "Scroll request is used to fetch large number of log messages in multiple batches with each LogResponse containing no more than 500 (max value for...",
|
|
10110
|
+
"x-f5xc-description-medium": "Scroll request is used to fetch large number of log messages in multiple batches with each LogResponse containing no more than 500 (max value for limit in the request) log messages. To scroll through more than 500 or all log messages, one can use the LogScrollRequest. Use the scroll_id returned...",
|
|
9670
10111
|
"x-f5xc-minimum-configuration": {
|
|
9671
10112
|
"description": "Minimum configuration for voltshareAuditLogScrollRequest",
|
|
9672
10113
|
"required_fields": [
|
|
@@ -9701,6 +10142,7 @@
|
|
|
9701
10142
|
"x-validation-rules": {
|
|
9702
10143
|
"ves.io.schema.rules.message.required": "true"
|
|
9703
10144
|
},
|
|
10145
|
+
"x-f5xc-description-short": "Blinded Encrypted Key in base64 format Required: YES.",
|
|
9704
10146
|
"minLength": 0,
|
|
9705
10147
|
"maxLength": 1024,
|
|
9706
10148
|
"x-f5xc-required-for": {
|
|
@@ -9727,6 +10169,7 @@
|
|
|
9727
10169
|
"x-validation-rules": {
|
|
9728
10170
|
"ves.io.schema.rules.message.required": "true"
|
|
9729
10171
|
},
|
|
10172
|
+
"x-f5xc-description-short": "Base64 encoded HMAC of the policy document Required: YES.",
|
|
9730
10173
|
"minLength": 0,
|
|
9731
10174
|
"maxLength": 1024,
|
|
9732
10175
|
"x-f5xc-required-for": {
|
|
@@ -9737,6 +10180,7 @@
|
|
|
9737
10180
|
}
|
|
9738
10181
|
}
|
|
9739
10182
|
},
|
|
10183
|
+
"x-f5xc-description-short": "DecryptSecretRequest contains parameters for DecryptSecret API.",
|
|
9740
10184
|
"x-f5xc-minimum-configuration": {
|
|
9741
10185
|
"description": "Minimum configuration for voltshareDecryptSecretRequest",
|
|
9742
10186
|
"required_fields": [
|
|
@@ -9775,6 +10219,7 @@
|
|
|
9775
10219
|
}
|
|
9776
10220
|
}
|
|
9777
10221
|
},
|
|
10222
|
+
"x-f5xc-description-short": "DecryptSecretResponse contains the response of DecryptSecret API.",
|
|
9778
10223
|
"x-f5xc-minimum-configuration": {
|
|
9779
10224
|
"description": "Minimum configuration for voltshareDecryptSecretResponse",
|
|
9780
10225
|
"required_fields": [
|
|
@@ -9805,6 +10250,7 @@
|
|
|
9805
10250
|
"x-displayname": "Blindfold KeyVersion.",
|
|
9806
10251
|
"x-ves-example": "0",
|
|
9807
10252
|
"x-f5xc-example": "0",
|
|
10253
|
+
"x-f5xc-description-short": "Version of BlindfoldKey that will be used for encryption.",
|
|
9808
10254
|
"minimum": 0,
|
|
9809
10255
|
"maximum": 2147483647,
|
|
9810
10256
|
"x-f5xc-required-for": {
|
|
@@ -9840,6 +10286,7 @@
|
|
|
9840
10286
|
"x-displayname": "PolicyID",
|
|
9841
10287
|
"x-ves-example": "0",
|
|
9842
10288
|
"x-f5xc-example": "0",
|
|
10289
|
+
"x-f5xc-description-short": "Unique 31 bit number assigned to this policy.",
|
|
9843
10290
|
"minLength": 0,
|
|
9844
10291
|
"maxLength": 1024,
|
|
9845
10292
|
"x-f5xc-required-for": {
|
|
@@ -9867,6 +10314,7 @@
|
|
|
9867
10314
|
}
|
|
9868
10315
|
}
|
|
9869
10316
|
},
|
|
10317
|
+
"x-f5xc-description-short": "PolicyInformation contains user defined policy and metadata added by the backend server.",
|
|
9870
10318
|
"x-f5xc-minimum-configuration": {
|
|
9871
10319
|
"description": "Minimum configuration for voltsharePolicyInformationType",
|
|
9872
10320
|
"required_fields": [
|
|
@@ -9906,6 +10354,7 @@
|
|
|
9906
10354
|
"x-validation-rules": {
|
|
9907
10355
|
"ves.io.schema.rules.repeated.max_items": "256"
|
|
9908
10356
|
},
|
|
10357
|
+
"x-f5xc-description-short": "List of Users allowed to decrypt the secret.",
|
|
9909
10358
|
"x-f5xc-required-for": {
|
|
9910
10359
|
"minimum_config": false,
|
|
9911
10360
|
"create": false,
|
|
@@ -9919,6 +10368,7 @@
|
|
|
9919
10368
|
"title": "Expiration_timestamp.",
|
|
9920
10369
|
"format": "date-time",
|
|
9921
10370
|
"x-displayname": "Expiration Time.",
|
|
10371
|
+
"x-f5xc-description-short": "Until when this policy is valid. After expiration only author can decrypt the secret.",
|
|
9922
10372
|
"minLength": 0,
|
|
9923
10373
|
"maxLength": 1024,
|
|
9924
10374
|
"x-f5xc-required-for": {
|
|
@@ -9929,6 +10379,7 @@
|
|
|
9929
10379
|
}
|
|
9930
10380
|
}
|
|
9931
10381
|
},
|
|
10382
|
+
"x-f5xc-description-short": "Policy contains user defined policy. It contains list of allowed users and expiry time.",
|
|
9932
10383
|
"x-f5xc-minimum-configuration": {
|
|
9933
10384
|
"description": "Minimum configuration for voltsharePolicyType",
|
|
9934
10385
|
"required_fields": [
|
|
@@ -9980,6 +10431,7 @@
|
|
|
9980
10431
|
}
|
|
9981
10432
|
}
|
|
9982
10433
|
},
|
|
10434
|
+
"x-f5xc-description-short": "ProcessPolicyRequest contains parameters ProcessPolicyInformation API.",
|
|
9983
10435
|
"x-f5xc-minimum-configuration": {
|
|
9984
10436
|
"description": "Minimum configuration for voltshareProcessPolicyRequest",
|
|
9985
10437
|
"required_fields": [
|
|
@@ -10010,6 +10462,7 @@
|
|
|
10010
10462
|
"x-displayname": "Policy Document HMAC.",
|
|
10011
10463
|
"x-ves-example": "Value",
|
|
10012
10464
|
"x-f5xc-example": "value",
|
|
10465
|
+
"x-f5xc-description-short": "Base64 encoded HMAC of the policy document.",
|
|
10013
10466
|
"minLength": 0,
|
|
10014
10467
|
"maxLength": 1024,
|
|
10015
10468
|
"x-f5xc-required-for": {
|
|
@@ -10026,6 +10479,8 @@
|
|
|
10026
10479
|
"x-displayname": "Public Key Document.",
|
|
10027
10480
|
"x-ves-example": "Value",
|
|
10028
10481
|
"x-f5xc-example": "value",
|
|
10482
|
+
"x-f5xc-description-short": "PublicKey Document contains information about PublicKey used to encrypt symmetric encryption key.",
|
|
10483
|
+
"x-f5xc-description-medium": "PublicKey Document contains information about PublicKey used to encrypt symmetric encryption key. Private part of this key is ONLY with F5XC Secret Management service. Value of this field is a base64 string.",
|
|
10029
10484
|
"minLength": 0,
|
|
10030
10485
|
"maxLength": 1024,
|
|
10031
10486
|
"x-f5xc-required-for": {
|
|
@@ -10036,6 +10491,8 @@
|
|
|
10036
10491
|
}
|
|
10037
10492
|
}
|
|
10038
10493
|
},
|
|
10494
|
+
"x-f5xc-description-short": "Response of the ProcessPolicyInformation API. It contains Processed Policy, HMAC of the policy and PublicKey to be used for encryption.",
|
|
10495
|
+
"x-f5xc-description-medium": "Response of the ProcessPolicyInformation API. It contains Processed Policy, HMAC of the policy and PublicKey to be used for encryption.",
|
|
10039
10496
|
"x-f5xc-minimum-configuration": {
|
|
10040
10497
|
"description": "Minimum configuration for voltshareProcessPolicyResponse",
|
|
10041
10498
|
"required_fields": [
|
|
@@ -10111,9 +10568,10 @@
|
|
|
10111
10568
|
"x-field-mutability": "read-only",
|
|
10112
10569
|
"x-original-maxLength": 256,
|
|
10113
10570
|
"x-reconciled-from-discovery": true,
|
|
10114
|
-
"x-reconciled-at": "2026-01-
|
|
10571
|
+
"x-reconciled-at": "2026-01-07T15:28:37.308007+00:00"
|
|
10115
10572
|
}
|
|
10116
10573
|
},
|
|
10574
|
+
"x-f5xc-description-short": "UserRecordType contains information about a user.",
|
|
10117
10575
|
"x-f5xc-minimum-configuration": {
|
|
10118
10576
|
"description": "Minimum configuration for voltshareUserRecordType",
|
|
10119
10577
|
"required_fields": [
|
|
@@ -10147,6 +10605,8 @@
|
|
|
10147
10605
|
"x-validation-rules": {
|
|
10148
10606
|
"ves.io.schema.rules.string.query_time": "true"
|
|
10149
10607
|
},
|
|
10608
|
+
"x-f5xc-description-short": "End time of metric collection from which data will be considered.",
|
|
10609
|
+
"x-f5xc-description-medium": "End time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
|
|
10150
10610
|
"minLength": 0,
|
|
10151
10611
|
"maxLength": 1024,
|
|
10152
10612
|
"x-f5xc-required-for": {
|
|
@@ -10164,6 +10624,8 @@
|
|
|
10164
10624
|
"$ref": "#/components/schemas/metricsVoltShareMetricLabel"
|
|
10165
10625
|
},
|
|
10166
10626
|
"x-displayname": "Group By",
|
|
10627
|
+
"x-f5xc-description-short": "Aggregate data by one or more labels listed here. OPERATION, RESULT, USER_TENANT, COUNTRY.",
|
|
10628
|
+
"x-f5xc-description-medium": "Aggregate data by one or more labels listed here. OPERATION, RESULT, USER_TENANT, COUNTRY. Optional: If not specified, then the metric is aggregated across all the labels.",
|
|
10167
10629
|
"x-f5xc-required-for": {
|
|
10168
10630
|
"minimum_config": false,
|
|
10169
10631
|
"create": false,
|
|
@@ -10179,6 +10641,8 @@
|
|
|
10179
10641
|
"$ref": "#/components/schemas/metricsVoltShareMetricLabelFilter"
|
|
10180
10642
|
},
|
|
10181
10643
|
"x-displayname": "Label Filter.",
|
|
10644
|
+
"x-f5xc-description-short": "List of label filter expressions of the form \"label\" Op \"value\".",
|
|
10645
|
+
"x-f5xc-description-medium": "List of label filter expressions of the form \"label\" Op \"value\". Response will only contain data that matches all the conditions specified in the label_filter. One or more of the following labels can be specified in the label_filter.",
|
|
10182
10646
|
"x-f5xc-required-for": {
|
|
10183
10647
|
"minimum_config": false,
|
|
10184
10648
|
"create": false,
|
|
@@ -10193,6 +10657,7 @@
|
|
|
10193
10657
|
"x-displayname": "Namespace",
|
|
10194
10658
|
"x-ves-example": "Blogging-app-namespace-1.",
|
|
10195
10659
|
"x-f5xc-example": "blogging-app-namespace-1",
|
|
10660
|
+
"x-f5xc-description-short": "Namespace is used to scope the security events for the given namespace.",
|
|
10196
10661
|
"minLength": 0,
|
|
10197
10662
|
"maxLength": 6,
|
|
10198
10663
|
"x-f5xc-required-for": {
|
|
@@ -10203,7 +10668,7 @@
|
|
|
10203
10668
|
},
|
|
10204
10669
|
"x-original-maxLength": 1024,
|
|
10205
10670
|
"x-reconciled-from-discovery": true,
|
|
10206
|
-
"x-reconciled-at": "2026-01-
|
|
10671
|
+
"x-reconciled-at": "2026-01-07T15:28:37.308017+00:00"
|
|
10207
10672
|
},
|
|
10208
10673
|
"start_time": {
|
|
10209
10674
|
"type": "string",
|
|
@@ -10218,6 +10683,8 @@
|
|
|
10218
10683
|
"x-validation-rules": {
|
|
10219
10684
|
"ves.io.schema.rules.string.query_time": "true"
|
|
10220
10685
|
},
|
|
10686
|
+
"x-f5xc-description-short": "Start time of metric collection from which data will be considered.",
|
|
10687
|
+
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
|
|
10221
10688
|
"minLength": 0,
|
|
10222
10689
|
"maxLength": 1024,
|
|
10223
10690
|
"x-f5xc-required-for": {
|
|
@@ -10240,6 +10707,8 @@
|
|
|
10240
10707
|
"x-validation-rules": {
|
|
10241
10708
|
"ves.io.schema.rules.string.query_step": "true"
|
|
10242
10709
|
},
|
|
10710
|
+
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
|
|
10711
|
+
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
|
|
10243
10712
|
"minLength": 0,
|
|
10244
10713
|
"maxLength": 1024,
|
|
10245
10714
|
"x-f5xc-required-for": {
|
|
@@ -10250,6 +10719,8 @@
|
|
|
10250
10719
|
}
|
|
10251
10720
|
}
|
|
10252
10721
|
},
|
|
10722
|
+
"x-f5xc-description-short": "Request to GET number of VoltShare API calls aggregated across multiple dimensions like OPERATION, COUNTRY, RESULT, USER_TENANT.",
|
|
10723
|
+
"x-f5xc-description-medium": "Request to GET number of VoltShare API calls aggregated across multiple dimensions like OPERATION, COUNTRY, RESULT, USER_TENANT.",
|
|
10253
10724
|
"x-f5xc-minimum-configuration": {
|
|
10254
10725
|
"description": "Minimum configuration for voltshareVoltShareAccessCountRequest",
|
|
10255
10726
|
"required_fields": [
|
|
@@ -10282,6 +10753,8 @@
|
|
|
10282
10753
|
"$ref": "#/components/schemas/metricsVoltShareAccessCounter"
|
|
10283
10754
|
},
|
|
10284
10755
|
"x-displayname": "VoltShare Access Count.",
|
|
10756
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
10757
|
+
"x-f5xc-description-short": "List of VoltShare Access count data for each unique combination of group_by labels.",
|
|
10285
10758
|
"x-f5xc-required-for": {
|
|
10286
10759
|
"minimum_config": false,
|
|
10287
10760
|
"create": false,
|
|
@@ -10302,6 +10775,8 @@
|
|
|
10302
10775
|
"x-validation-rules": {
|
|
10303
10776
|
"ves.io.schema.rules.string.time_interval": "true"
|
|
10304
10777
|
},
|
|
10778
|
+
"x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.",
|
|
10779
|
+
"x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
|
|
10305
10780
|
"minLength": 0,
|
|
10306
10781
|
"maxLength": 1024,
|
|
10307
10782
|
"x-f5xc-required-for": {
|
|
@@ -10312,6 +10787,8 @@
|
|
|
10312
10787
|
}
|
|
10313
10788
|
}
|
|
10314
10789
|
},
|
|
10790
|
+
"x-f5xc-description-short": "VoltShare access count for each unique combination of group_by labels in the VoltShareAccessCountRequest.",
|
|
10791
|
+
"x-f5xc-description-medium": "VoltShare access count for each unique combination of group_by labels in the VoltShareAccessCountRequest.",
|
|
10315
10792
|
"x-f5xc-minimum-configuration": {
|
|
10316
10793
|
"description": "Minimum configuration for voltshareVoltShareAccessCountResponse",
|
|
10317
10794
|
"required_fields": [
|
|
@@ -10331,6 +10808,7 @@
|
|
|
10331
10808
|
"title": "Empty",
|
|
10332
10809
|
"x-displayname": "Empty",
|
|
10333
10810
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
10811
|
+
"x-f5xc-description-short": "Can be used for messages where no values are needed.",
|
|
10334
10812
|
"x-f5xc-minimum-configuration": {
|
|
10335
10813
|
"description": "Minimum configuration for ioschemaEmpty",
|
|
10336
10814
|
"required_fields": [],
|
|
@@ -10348,6 +10826,8 @@
|
|
|
10348
10826
|
"type_url": {
|
|
10349
10827
|
"type": "string",
|
|
10350
10828
|
"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.",
|
|
10829
|
+
"x-f5xc-description-short": "URL identifying the protocol buffer message type.",
|
|
10830
|
+
"x-f5xc-description-medium": "URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in ).",
|
|
10351
10831
|
"minLength": 0,
|
|
10352
10832
|
"maxLength": 1024,
|
|
10353
10833
|
"x-f5xc-required-for": {
|
|
@@ -10371,9 +10851,11 @@
|
|
|
10371
10851
|
},
|
|
10372
10852
|
"x-original-maxLength": 1024,
|
|
10373
10853
|
"x-reconciled-from-discovery": true,
|
|
10374
|
-
"x-reconciled-at": "2026-01-
|
|
10854
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963355+00:00"
|
|
10375
10855
|
}
|
|
10376
10856
|
},
|
|
10857
|
+
"x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
|
|
10858
|
+
"x-f5xc-description-medium": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a...",
|
|
10377
10859
|
"x-f5xc-minimum-configuration": {
|
|
10378
10860
|
"description": "Minimum configuration for protobufAny",
|
|
10379
10861
|
"required_fields": [
|
|
@@ -10415,6 +10897,7 @@
|
|
|
10415
10897
|
"$ref": "#/components/schemas/schemaSecretType"
|
|
10416
10898
|
}
|
|
10417
10899
|
},
|
|
10900
|
+
"x-f5xc-description-short": "AppRoleAuthInfoType contains parameters for AppRole authentication in Hashicorp Vault.",
|
|
10418
10901
|
"x-f5xc-minimum-configuration": {
|
|
10419
10902
|
"description": "Minimum configuration for schemaAppRoleAuthInfoType",
|
|
10420
10903
|
"required_fields": [
|
|
@@ -10445,6 +10928,7 @@
|
|
|
10445
10928
|
"x-displayname": "Username",
|
|
10446
10929
|
"x-ves-example": "Value",
|
|
10447
10930
|
"x-f5xc-example": "value",
|
|
10931
|
+
"x-f5xc-description-short": "The username to encode in Basic Auth scheme.",
|
|
10448
10932
|
"minLength": 0,
|
|
10449
10933
|
"maxLength": 1024,
|
|
10450
10934
|
"x-f5xc-required-for": {
|
|
@@ -10455,6 +10939,7 @@
|
|
|
10455
10939
|
}
|
|
10456
10940
|
}
|
|
10457
10941
|
},
|
|
10942
|
+
"x-f5xc-description-short": "AuthnTypeBasicAuth is used for using basic_auth mode of HTTP authentication.",
|
|
10458
10943
|
"x-f5xc-minimum-configuration": {
|
|
10459
10944
|
"description": "Minimum configuration for schemaAuthnTypeBasicAuth",
|
|
10460
10945
|
"required_fields": [
|
|
@@ -10490,6 +10975,8 @@
|
|
|
10490
10975
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
10491
10976
|
"ves.io.schema.rules.map.max_pairs": "16"
|
|
10492
10977
|
},
|
|
10978
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
10979
|
+
"x-f5xc-description-short": "The set of authentication headers to pass in HTTP request.",
|
|
10493
10980
|
"x-f5xc-required-for": {
|
|
10494
10981
|
"minimum_config": false,
|
|
10495
10982
|
"create": false,
|
|
@@ -10498,6 +10985,7 @@
|
|
|
10498
10985
|
}
|
|
10499
10986
|
}
|
|
10500
10987
|
},
|
|
10988
|
+
"x-f5xc-description-short": "AuthnTypeHeaders is used for setting headers for authentication.",
|
|
10501
10989
|
"x-f5xc-minimum-configuration": {
|
|
10502
10990
|
"description": "Minimum configuration for schemaAuthnTypeHeaders",
|
|
10503
10991
|
"required_fields": [
|
|
@@ -10532,6 +11020,7 @@
|
|
|
10532
11020
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
10533
11021
|
"ves.io.schema.rules.map.max_pairs": "16"
|
|
10534
11022
|
},
|
|
11023
|
+
"x-f5xc-description-short": "The set of authentication parameters to be passed as query parameters.",
|
|
10535
11024
|
"x-f5xc-required-for": {
|
|
10536
11025
|
"minimum_config": false,
|
|
10537
11026
|
"create": false,
|
|
@@ -10540,6 +11029,7 @@
|
|
|
10540
11029
|
}
|
|
10541
11030
|
}
|
|
10542
11031
|
},
|
|
11032
|
+
"x-f5xc-description-short": "AuthnTypeQueryParams is used for setting query_params for authentication.",
|
|
10543
11033
|
"x-f5xc-minimum-configuration": {
|
|
10544
11034
|
"description": "Minimum configuration for schemaAuthnTypeQueryParams",
|
|
10545
11035
|
"required_fields": [
|
|
@@ -10567,6 +11057,8 @@
|
|
|
10567
11057
|
"x-displayname": "Decryption Provider.",
|
|
10568
11058
|
"x-ves-example": "Value",
|
|
10569
11059
|
"x-f5xc-example": "value",
|
|
11060
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
11061
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
10570
11062
|
"minLength": 0,
|
|
10571
11063
|
"maxLength": 1024,
|
|
10572
11064
|
"x-f5xc-required-for": {
|
|
@@ -10592,6 +11084,8 @@
|
|
|
10592
11084
|
"ves.io.schema.rules.message.required": "true",
|
|
10593
11085
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
10594
11086
|
},
|
|
11087
|
+
"x-f5xc-description-short": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
|
|
11088
|
+
"x-f5xc-description-medium": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
|
|
10595
11089
|
"minLength": 0,
|
|
10596
11090
|
"maxLength": 4,
|
|
10597
11091
|
"x-f5xc-required-for": {
|
|
@@ -10602,7 +11096,7 @@
|
|
|
10602
11096
|
},
|
|
10603
11097
|
"x-original-maxLength": 1024,
|
|
10604
11098
|
"x-reconciled-from-discovery": true,
|
|
10605
|
-
"x-reconciled-at": "2026-01-
|
|
11099
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963377+00:00"
|
|
10606
11100
|
},
|
|
10607
11101
|
"store_provider": {
|
|
10608
11102
|
"type": "string",
|
|
@@ -10611,6 +11105,8 @@
|
|
|
10611
11105
|
"x-displayname": "Store Provider.",
|
|
10612
11106
|
"x-ves-example": "Value",
|
|
10613
11107
|
"x-f5xc-example": "value",
|
|
11108
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
|
|
11109
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
|
|
10614
11110
|
"minLength": 0,
|
|
10615
11111
|
"maxLength": 1024,
|
|
10616
11112
|
"x-f5xc-required-for": {
|
|
@@ -10621,6 +11117,7 @@
|
|
|
10621
11117
|
}
|
|
10622
11118
|
}
|
|
10623
11119
|
},
|
|
11120
|
+
"x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
|
|
10624
11121
|
"x-f5xc-minimum-configuration": {
|
|
10625
11122
|
"description": "Minimum configuration for schemaBlindfoldSecretInfoType",
|
|
10626
11123
|
"required_fields": [
|
|
@@ -10650,6 +11147,8 @@
|
|
|
10650
11147
|
"x-displayname": "Provider",
|
|
10651
11148
|
"x-ves-example": "Box-provider.",
|
|
10652
11149
|
"x-f5xc-example": "box-provider",
|
|
11150
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
|
|
11151
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
|
|
10653
11152
|
"minLength": 0,
|
|
10654
11153
|
"maxLength": 8,
|
|
10655
11154
|
"x-f5xc-required-for": {
|
|
@@ -10660,7 +11159,7 @@
|
|
|
10660
11159
|
},
|
|
10661
11160
|
"x-original-maxLength": 1024,
|
|
10662
11161
|
"x-reconciled-from-discovery": true,
|
|
10663
|
-
"x-reconciled-at": "2026-01-
|
|
11162
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963383+00:00"
|
|
10664
11163
|
},
|
|
10665
11164
|
"url": {
|
|
10666
11165
|
"type": "string",
|
|
@@ -10681,6 +11180,8 @@
|
|
|
10681
11180
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
10682
11181
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
10683
11182
|
},
|
|
11183
|
+
"x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
|
|
11184
|
+
"x-f5xc-description-medium": "URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.",
|
|
10684
11185
|
"format": "uri",
|
|
10685
11186
|
"minLength": 0,
|
|
10686
11187
|
"x-f5xc-required-for": {
|
|
@@ -10691,6 +11192,7 @@
|
|
|
10691
11192
|
}
|
|
10692
11193
|
}
|
|
10693
11194
|
},
|
|
11195
|
+
"x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
|
|
10694
11196
|
"x-f5xc-minimum-configuration": {
|
|
10695
11197
|
"description": "Minimum configuration for schemaClearSecretInfoType",
|
|
10696
11198
|
"required_fields": [
|
|
@@ -10716,6 +11218,8 @@
|
|
|
10716
11218
|
"description": "Hostname of the instance of the site that sent the status.",
|
|
10717
11219
|
"title": "Hostname",
|
|
10718
11220
|
"x-displayname": "Hostname",
|
|
11221
|
+
"x-f5xc-example": "example-resource",
|
|
11222
|
+
"x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
|
|
10719
11223
|
"minLength": 0,
|
|
10720
11224
|
"maxLength": 1024,
|
|
10721
11225
|
"x-f5xc-required-for": {
|
|
@@ -10747,6 +11251,8 @@
|
|
|
10747
11251
|
"x-displayname": "Reason",
|
|
10748
11252
|
"x-ves-example": "Value",
|
|
10749
11253
|
"x-f5xc-example": "value",
|
|
11254
|
+
"x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
11255
|
+
"x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
10750
11256
|
"minLength": 0,
|
|
10751
11257
|
"maxLength": 43,
|
|
10752
11258
|
"x-f5xc-required-for": {
|
|
@@ -10757,13 +11263,15 @@
|
|
|
10757
11263
|
},
|
|
10758
11264
|
"x-original-maxLength": 1024,
|
|
10759
11265
|
"x-reconciled-from-discovery": true,
|
|
10760
|
-
"x-reconciled-at": "2026-01-
|
|
11266
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963393+00:00"
|
|
10761
11267
|
},
|
|
10762
11268
|
"service_name": {
|
|
10763
11269
|
"type": "string",
|
|
10764
11270
|
"description": "Name of the service that sent the status.",
|
|
10765
11271
|
"title": "Service name.",
|
|
10766
11272
|
"x-displayname": "Service Name.",
|
|
11273
|
+
"x-f5xc-example": "example-resource",
|
|
11274
|
+
"x-f5xc-description-short": "Name of the service that sent the status.",
|
|
10767
11275
|
"minLength": 0,
|
|
10768
11276
|
"maxLength": 1024,
|
|
10769
11277
|
"x-f5xc-required-for": {
|
|
@@ -10786,6 +11294,8 @@
|
|
|
10786
11294
|
"x-validation-rules": {
|
|
10787
11295
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
|
|
10788
11296
|
},
|
|
11297
|
+
"x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
|
|
11298
|
+
"x-f5xc-description-medium": "Status of the condition \"Success\" Validtion has succeded. Requested operation was successful. \"Failed\" Validation has failed. \"Incomplete\" Validation of configuration has failed due to missing configuration. \"Installed\" Validation has passed and configuration has been installed in data path or...",
|
|
10789
11299
|
"minLength": 0,
|
|
10790
11300
|
"maxLength": 17,
|
|
10791
11301
|
"x-f5xc-required-for": {
|
|
@@ -10796,7 +11306,7 @@
|
|
|
10796
11306
|
},
|
|
10797
11307
|
"x-original-maxLength": 1024,
|
|
10798
11308
|
"x-reconciled-from-discovery": true,
|
|
10799
|
-
"x-reconciled-at": "2026-01-
|
|
11309
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963399+00:00"
|
|
10800
11310
|
},
|
|
10801
11311
|
"type": {
|
|
10802
11312
|
"type": "string",
|
|
@@ -10811,6 +11321,8 @@
|
|
|
10811
11321
|
"x-validation-rules": {
|
|
10812
11322
|
"ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
|
|
10813
11323
|
},
|
|
11324
|
+
"x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
|
|
11325
|
+
"x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
|
|
10814
11326
|
"minLength": 0,
|
|
10815
11327
|
"maxLength": 1024,
|
|
10816
11328
|
"x-f5xc-required-for": {
|
|
@@ -10821,6 +11333,8 @@
|
|
|
10821
11333
|
}
|
|
10822
11334
|
}
|
|
10823
11335
|
},
|
|
11336
|
+
"x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
|
|
11337
|
+
"x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
|
|
10824
11338
|
"x-f5xc-minimum-configuration": {
|
|
10825
11339
|
"description": "Minimum configuration for schemaConditionType",
|
|
10826
11340
|
"required_fields": [
|
|
@@ -10856,6 +11370,8 @@
|
|
|
10856
11370
|
"default": "EOK",
|
|
10857
11371
|
"x-displayname": "Error Code.",
|
|
10858
11372
|
"x-ves-proto-enum": "ves.io.schema.ErrorCode",
|
|
11373
|
+
"x-f5xc-description-short": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found...",
|
|
11374
|
+
"x-f5xc-description-medium": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found - EEXISTS: Already exists - EUNKNOWN: Unknown/catchall error - ESERIALIZE: Error in serializing/de-serializing - EINTERNAL: Server error - EPARTIAL...",
|
|
10859
11375
|
"x-f5xc-minimum-configuration": {
|
|
10860
11376
|
"description": "Minimum configuration for schemaErrorCode",
|
|
10861
11377
|
"required_fields": [],
|
|
@@ -10896,6 +11412,7 @@
|
|
|
10896
11412
|
}
|
|
10897
11413
|
}
|
|
10898
11414
|
},
|
|
11415
|
+
"x-f5xc-description-short": "Information about a error in API operation.",
|
|
10899
11416
|
"x-f5xc-minimum-configuration": {
|
|
10900
11417
|
"description": "Minimum configuration for schemaErrorType",
|
|
10901
11418
|
"required_fields": [
|
|
@@ -10922,6 +11439,8 @@
|
|
|
10922
11439
|
"default": "INVALID_HASH_ALGORITHM",
|
|
10923
11440
|
"x-displayname": "Hash Algorithm.",
|
|
10924
11441
|
"x-ves-proto-enum": "ves.io.schema.HashAlgorithm",
|
|
11442
|
+
"x-f5xc-description-short": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.",
|
|
11443
|
+
"x-f5xc-description-medium": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.",
|
|
10925
11444
|
"x-f5xc-minimum-configuration": {
|
|
10926
11445
|
"description": "Minimum configuration for schemaHashAlgorithm",
|
|
10927
11446
|
"required_fields": [],
|
|
@@ -10962,6 +11481,7 @@
|
|
|
10962
11481
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
10963
11482
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
10964
11483
|
},
|
|
11484
|
+
"x-f5xc-description-short": "Ordered list of hash algorithms to be used. Required: YES.",
|
|
10965
11485
|
"x-f5xc-required-for": {
|
|
10966
11486
|
"minimum_config": false,
|
|
10967
11487
|
"create": false,
|
|
@@ -10970,6 +11490,7 @@
|
|
|
10970
11490
|
}
|
|
10971
11491
|
}
|
|
10972
11492
|
},
|
|
11493
|
+
"x-f5xc-description-short": "Specifies the hash algorithms to be used.",
|
|
10973
11494
|
"x-f5xc-minimum-configuration": {
|
|
10974
11495
|
"description": "Minimum configuration for schemaHashAlgorithms",
|
|
10975
11496
|
"required_fields": [
|
|
@@ -11016,6 +11537,7 @@
|
|
|
11016
11537
|
"ves.io.schema.rules.string.max_len": "256",
|
|
11017
11538
|
"ves.io.schema.rules.string.min_len": "1"
|
|
11018
11539
|
},
|
|
11540
|
+
"x-f5xc-description-short": "Endpoint to connect to, in host:port format Required: YES.",
|
|
11019
11541
|
"x-f5xc-required-for": {
|
|
11020
11542
|
"minimum_config": false,
|
|
11021
11543
|
"create": false,
|
|
@@ -11030,6 +11552,7 @@
|
|
|
11030
11552
|
"$ref": "#/components/schemas/schemaVaultAuthInfoType"
|
|
11031
11553
|
}
|
|
11032
11554
|
},
|
|
11555
|
+
"x-f5xc-description-short": "HostAccessInfoType contains the information about how to connect to the remote host.",
|
|
11033
11556
|
"x-f5xc-minimum-configuration": {
|
|
11034
11557
|
"description": "Minimum configuration for schemaHostAccessInfoType",
|
|
11035
11558
|
"required_fields": [
|
|
@@ -11059,6 +11582,7 @@
|
|
|
11059
11582
|
"title": "Name",
|
|
11060
11583
|
"x-displayname": "Name",
|
|
11061
11584
|
"x-f5xc-example": "example-resource",
|
|
11585
|
+
"x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
|
|
11062
11586
|
"minLength": 0,
|
|
11063
11587
|
"maxLength": 16,
|
|
11064
11588
|
"x-f5xc-required-for": {
|
|
@@ -11069,9 +11593,10 @@
|
|
|
11069
11593
|
},
|
|
11070
11594
|
"x-original-maxLength": 1024,
|
|
11071
11595
|
"x-reconciled-from-discovery": true,
|
|
11072
|
-
"x-reconciled-at": "2026-01-
|
|
11596
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963419+00:00"
|
|
11073
11597
|
}
|
|
11074
11598
|
},
|
|
11599
|
+
"x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
|
|
11075
11600
|
"x-f5xc-minimum-configuration": {
|
|
11076
11601
|
"description": "Minimum configuration for schemaInitializerType",
|
|
11077
11602
|
"required_fields": [
|
|
@@ -11099,6 +11624,8 @@
|
|
|
11099
11624
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
11100
11625
|
},
|
|
11101
11626
|
"x-displayname": "Pending",
|
|
11627
|
+
"x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
|
|
11628
|
+
"x-f5xc-description-medium": "Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.",
|
|
11102
11629
|
"x-f5xc-required-for": {
|
|
11103
11630
|
"minimum_config": false,
|
|
11104
11631
|
"create": false,
|
|
@@ -11110,6 +11637,7 @@
|
|
|
11110
11637
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
11111
11638
|
}
|
|
11112
11639
|
},
|
|
11640
|
+
"x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
|
|
11113
11641
|
"x-f5xc-minimum-configuration": {
|
|
11114
11642
|
"description": "Minimum configuration for schemaInitializersType",
|
|
11115
11643
|
"required_fields": [
|
|
@@ -11148,6 +11676,7 @@
|
|
|
11148
11676
|
"ves.io.schema.rules.message.required": "true",
|
|
11149
11677
|
"ves.io.schema.rules.repeated.max_items": "1"
|
|
11150
11678
|
},
|
|
11679
|
+
"x-f5xc-description-short": "Virtual network direct reference Required: YES.",
|
|
11151
11680
|
"x-f5xc-required-for": {
|
|
11152
11681
|
"minimum_config": false,
|
|
11153
11682
|
"create": false,
|
|
@@ -11156,6 +11685,7 @@
|
|
|
11156
11685
|
}
|
|
11157
11686
|
}
|
|
11158
11687
|
},
|
|
11688
|
+
"x-f5xc-description-short": "Specifies a direct reference to a network configuration object.",
|
|
11159
11689
|
"x-f5xc-minimum-configuration": {
|
|
11160
11690
|
"description": "Minimum configuration for schemaNetworkRefType",
|
|
11161
11691
|
"required_fields": [
|
|
@@ -11186,6 +11716,8 @@
|
|
|
11186
11716
|
"$ref": "#/components/schemas/schemaVSiteRefType"
|
|
11187
11717
|
}
|
|
11188
11718
|
},
|
|
11719
|
+
"x-f5xc-description-short": "NetworkSiteRefSelector defines a union of reference to site or reference to virtual_network or reference to virtual_site It is used to determine...",
|
|
11720
|
+
"x-f5xc-description-medium": "NetworkSiteRefSelector defines a union of reference to site or reference to virtual_network or reference to virtual_site It is used to determine virtual network using following rules * Direct reference to virtual_network object * Site local network when refering to site object * All site local...",
|
|
11189
11721
|
"x-f5xc-minimum-configuration": {
|
|
11190
11722
|
"description": "Minimum configuration for schemaNetworkSiteRefSelector",
|
|
11191
11723
|
"required_fields": [
|
|
@@ -11225,6 +11757,8 @@
|
|
|
11225
11757
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
11226
11758
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
11227
11759
|
},
|
|
11760
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
11761
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
11228
11762
|
"x-f5xc-required-for": {
|
|
11229
11763
|
"minimum_config": false,
|
|
11230
11764
|
"create": false,
|
|
@@ -11246,6 +11780,7 @@
|
|
|
11246
11780
|
"x-validation-rules": {
|
|
11247
11781
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
11248
11782
|
},
|
|
11783
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
11249
11784
|
"minLength": 0,
|
|
11250
11785
|
"x-f5xc-required-for": {
|
|
11251
11786
|
"minimum_config": false,
|
|
@@ -11255,7 +11790,7 @@
|
|
|
11255
11790
|
},
|
|
11256
11791
|
"x-original-maxLength": 1200,
|
|
11257
11792
|
"x-reconciled-from-discovery": true,
|
|
11258
|
-
"x-reconciled-at": "2026-01-
|
|
11793
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963436+00:00"
|
|
11259
11794
|
},
|
|
11260
11795
|
"disable": {
|
|
11261
11796
|
"type": "boolean",
|
|
@@ -11264,6 +11799,7 @@
|
|
|
11264
11799
|
"format": "boolean",
|
|
11265
11800
|
"x-displayname": "Disable",
|
|
11266
11801
|
"x-f5xc-example": "true",
|
|
11802
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
11267
11803
|
"x-f5xc-required-for": {
|
|
11268
11804
|
"minimum_config": false,
|
|
11269
11805
|
"create": false,
|
|
@@ -11277,6 +11813,8 @@
|
|
|
11277
11813
|
"title": "Labels",
|
|
11278
11814
|
"x-displayname": "Labels",
|
|
11279
11815
|
"x-f5xc-example": "value",
|
|
11816
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
11817
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
11280
11818
|
"x-f5xc-required-for": {
|
|
11281
11819
|
"minimum_config": false,
|
|
11282
11820
|
"create": false,
|
|
@@ -11298,6 +11836,8 @@
|
|
|
11298
11836
|
"x-validation-rules": {
|
|
11299
11837
|
"ves.io.schema.rules.message.required": "true"
|
|
11300
11838
|
},
|
|
11839
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
11840
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
11301
11841
|
"minLength": 0,
|
|
11302
11842
|
"maxLength": 16,
|
|
11303
11843
|
"x-f5xc-required-for": {
|
|
@@ -11308,7 +11848,7 @@
|
|
|
11308
11848
|
},
|
|
11309
11849
|
"x-original-maxLength": 1024,
|
|
11310
11850
|
"x-reconciled-from-discovery": true,
|
|
11311
|
-
"x-reconciled-at": "2026-01-
|
|
11851
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963443+00:00"
|
|
11312
11852
|
},
|
|
11313
11853
|
"namespace": {
|
|
11314
11854
|
"type": "string",
|
|
@@ -11317,6 +11857,8 @@
|
|
|
11317
11857
|
"x-displayname": "Namespace",
|
|
11318
11858
|
"x-ves-example": "Staging",
|
|
11319
11859
|
"x-f5xc-example": "staging",
|
|
11860
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
11861
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
11320
11862
|
"minLength": 0,
|
|
11321
11863
|
"maxLength": 6,
|
|
11322
11864
|
"x-f5xc-required-for": {
|
|
@@ -11327,9 +11869,10 @@
|
|
|
11327
11869
|
},
|
|
11328
11870
|
"x-original-maxLength": 1024,
|
|
11329
11871
|
"x-reconciled-from-discovery": true,
|
|
11330
|
-
"x-reconciled-at": "2026-01-
|
|
11872
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963448+00:00"
|
|
11331
11873
|
}
|
|
11332
11874
|
},
|
|
11875
|
+
"x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
|
|
11333
11876
|
"x-f5xc-minimum-configuration": {
|
|
11334
11877
|
"description": "Minimum configuration for schemaObjectCreateMetaType",
|
|
11335
11878
|
"required_fields": [
|
|
@@ -11373,6 +11916,8 @@
|
|
|
11373
11916
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
11374
11917
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
11375
11918
|
},
|
|
11919
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
11920
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
11376
11921
|
"x-f5xc-required-for": {
|
|
11377
11922
|
"minimum_config": false,
|
|
11378
11923
|
"create": false,
|
|
@@ -11394,6 +11939,7 @@
|
|
|
11394
11939
|
"x-validation-rules": {
|
|
11395
11940
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
11396
11941
|
},
|
|
11942
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
11397
11943
|
"minLength": 0,
|
|
11398
11944
|
"x-f5xc-required-for": {
|
|
11399
11945
|
"minimum_config": false,
|
|
@@ -11403,7 +11949,7 @@
|
|
|
11403
11949
|
},
|
|
11404
11950
|
"x-original-maxLength": 1200,
|
|
11405
11951
|
"x-reconciled-from-discovery": true,
|
|
11406
|
-
"x-reconciled-at": "2026-01-
|
|
11952
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963454+00:00"
|
|
11407
11953
|
},
|
|
11408
11954
|
"disable": {
|
|
11409
11955
|
"type": "boolean",
|
|
@@ -11413,6 +11959,7 @@
|
|
|
11413
11959
|
"x-displayname": "Disable",
|
|
11414
11960
|
"x-ves-example": "True",
|
|
11415
11961
|
"x-f5xc-example": "true",
|
|
11962
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
11416
11963
|
"x-f5xc-required-for": {
|
|
11417
11964
|
"minimum_config": false,
|
|
11418
11965
|
"create": false,
|
|
@@ -11427,6 +11974,8 @@
|
|
|
11427
11974
|
"x-displayname": "Labels",
|
|
11428
11975
|
"x-ves-example": "Value",
|
|
11429
11976
|
"x-f5xc-example": "value",
|
|
11977
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
11978
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
11430
11979
|
"x-f5xc-required-for": {
|
|
11431
11980
|
"minimum_config": false,
|
|
11432
11981
|
"create": false,
|
|
@@ -11448,6 +11997,8 @@
|
|
|
11448
11997
|
"x-validation-rules": {
|
|
11449
11998
|
"ves.io.schema.rules.message.required": "true"
|
|
11450
11999
|
},
|
|
12000
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
12001
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
11451
12002
|
"minLength": 0,
|
|
11452
12003
|
"maxLength": 16,
|
|
11453
12004
|
"x-f5xc-required-for": {
|
|
@@ -11458,7 +12009,7 @@
|
|
|
11458
12009
|
},
|
|
11459
12010
|
"x-original-maxLength": 1024,
|
|
11460
12011
|
"x-reconciled-from-discovery": true,
|
|
11461
|
-
"x-reconciled-at": "2026-01-
|
|
12012
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963461+00:00"
|
|
11462
12013
|
},
|
|
11463
12014
|
"namespace": {
|
|
11464
12015
|
"type": "string",
|
|
@@ -11467,6 +12018,8 @@
|
|
|
11467
12018
|
"x-displayname": "Namespace",
|
|
11468
12019
|
"x-ves-example": "Staging",
|
|
11469
12020
|
"x-f5xc-example": "staging",
|
|
12021
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
12022
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
11470
12023
|
"minLength": 0,
|
|
11471
12024
|
"maxLength": 6,
|
|
11472
12025
|
"x-f5xc-required-for": {
|
|
@@ -11477,9 +12030,10 @@
|
|
|
11477
12030
|
},
|
|
11478
12031
|
"x-original-maxLength": 1024,
|
|
11479
12032
|
"x-reconciled-from-discovery": true,
|
|
11480
|
-
"x-reconciled-at": "2026-01-
|
|
12033
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963465+00:00"
|
|
11481
12034
|
}
|
|
11482
12035
|
},
|
|
12036
|
+
"x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
|
|
11483
12037
|
"x-f5xc-minimum-configuration": {
|
|
11484
12038
|
"description": "Minimum configuration for schemaObjectGetMetaType",
|
|
11485
12039
|
"required_fields": [
|
|
@@ -11511,6 +12065,8 @@
|
|
|
11511
12065
|
"x-displayname": "Kind",
|
|
11512
12066
|
"x-ves-example": "Virtual_site.",
|
|
11513
12067
|
"x-f5xc-example": "virtual_site",
|
|
12068
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")",
|
|
12069
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").",
|
|
11514
12070
|
"minLength": 0,
|
|
11515
12071
|
"maxLength": 14,
|
|
11516
12072
|
"x-f5xc-required-for": {
|
|
@@ -11522,7 +12078,7 @@
|
|
|
11522
12078
|
"readOnly": true,
|
|
11523
12079
|
"x-original-maxLength": 1024,
|
|
11524
12080
|
"x-reconciled-from-discovery": true,
|
|
11525
|
-
"x-reconciled-at": "2026-01-
|
|
12081
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963470+00:00"
|
|
11526
12082
|
},
|
|
11527
12083
|
"name": {
|
|
11528
12084
|
"type": "string",
|
|
@@ -11531,6 +12087,8 @@
|
|
|
11531
12087
|
"x-displayname": "Name",
|
|
11532
12088
|
"x-ves-example": "Contactus-route.",
|
|
11533
12089
|
"x-f5xc-example": "contactus-route",
|
|
12090
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
|
|
12091
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
|
|
11534
12092
|
"minLength": 0,
|
|
11535
12093
|
"maxLength": 16,
|
|
11536
12094
|
"x-f5xc-required-for": {
|
|
@@ -11541,7 +12099,7 @@
|
|
|
11541
12099
|
},
|
|
11542
12100
|
"x-original-maxLength": 1024,
|
|
11543
12101
|
"x-reconciled-from-discovery": true,
|
|
11544
|
-
"x-reconciled-at": "2026-01-
|
|
12102
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963474+00:00"
|
|
11545
12103
|
},
|
|
11546
12104
|
"namespace": {
|
|
11547
12105
|
"type": "string",
|
|
@@ -11550,6 +12108,8 @@
|
|
|
11550
12108
|
"x-displayname": "Namespace",
|
|
11551
12109
|
"x-ves-example": "Ns1",
|
|
11552
12110
|
"x-f5xc-example": "ns1",
|
|
12111
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
|
|
12112
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
|
|
11553
12113
|
"minLength": 0,
|
|
11554
12114
|
"maxLength": 6,
|
|
11555
12115
|
"x-f5xc-required-for": {
|
|
@@ -11560,7 +12120,7 @@
|
|
|
11560
12120
|
},
|
|
11561
12121
|
"x-original-maxLength": 1024,
|
|
11562
12122
|
"x-reconciled-from-discovery": true,
|
|
11563
|
-
"x-reconciled-at": "2026-01-
|
|
12123
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963478+00:00"
|
|
11564
12124
|
},
|
|
11565
12125
|
"tenant": {
|
|
11566
12126
|
"type": "string",
|
|
@@ -11569,6 +12129,8 @@
|
|
|
11569
12129
|
"x-displayname": "Tenant",
|
|
11570
12130
|
"x-ves-example": "Example-corp.",
|
|
11571
12131
|
"x-f5xc-example": "example-corp",
|
|
12132
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.",
|
|
12133
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.",
|
|
11572
12134
|
"minLength": 0,
|
|
11573
12135
|
"maxLength": 18,
|
|
11574
12136
|
"x-f5xc-required-for": {
|
|
@@ -11581,7 +12143,7 @@
|
|
|
11581
12143
|
"x-field-mutability": "read-only",
|
|
11582
12144
|
"x-original-maxLength": 1024,
|
|
11583
12145
|
"x-reconciled-from-discovery": true,
|
|
11584
|
-
"x-reconciled-at": "2026-01-
|
|
12146
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963482+00:00"
|
|
11585
12147
|
},
|
|
11586
12148
|
"uid": {
|
|
11587
12149
|
"type": "string",
|
|
@@ -11590,6 +12152,8 @@
|
|
|
11590
12152
|
"x-displayname": "UID",
|
|
11591
12153
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
11592
12154
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
12155
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.",
|
|
12156
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.",
|
|
11593
12157
|
"minLength": 0,
|
|
11594
12158
|
"maxLength": 36,
|
|
11595
12159
|
"x-f5xc-required-for": {
|
|
@@ -11603,9 +12167,11 @@
|
|
|
11603
12167
|
"x-original-maxLength": 1024,
|
|
11604
12168
|
"format": "uuid",
|
|
11605
12169
|
"x-reconciled-from-discovery": true,
|
|
11606
|
-
"x-reconciled-at": "2026-01-
|
|
12170
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963487+00:00"
|
|
11607
12171
|
}
|
|
11608
12172
|
},
|
|
12173
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
12174
|
+
"x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...",
|
|
11609
12175
|
"x-f5xc-minimum-configuration": {
|
|
11610
12176
|
"description": "Minimum configuration for schemaObjectRefType",
|
|
11611
12177
|
"required_fields": [
|
|
@@ -11648,6 +12214,8 @@
|
|
|
11648
12214
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
11649
12215
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
11650
12216
|
},
|
|
12217
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
12218
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
11651
12219
|
"x-f5xc-required-for": {
|
|
11652
12220
|
"minimum_config": false,
|
|
11653
12221
|
"create": false,
|
|
@@ -11669,6 +12237,7 @@
|
|
|
11669
12237
|
"x-validation-rules": {
|
|
11670
12238
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
11671
12239
|
},
|
|
12240
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
11672
12241
|
"minLength": 0,
|
|
11673
12242
|
"x-f5xc-required-for": {
|
|
11674
12243
|
"minimum_config": false,
|
|
@@ -11678,7 +12247,7 @@
|
|
|
11678
12247
|
},
|
|
11679
12248
|
"x-original-maxLength": 1200,
|
|
11680
12249
|
"x-reconciled-from-discovery": true,
|
|
11681
|
-
"x-reconciled-at": "2026-01-
|
|
12250
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963496+00:00"
|
|
11682
12251
|
},
|
|
11683
12252
|
"disable": {
|
|
11684
12253
|
"type": "boolean",
|
|
@@ -11687,6 +12256,7 @@
|
|
|
11687
12256
|
"format": "boolean",
|
|
11688
12257
|
"x-displayname": "Disable",
|
|
11689
12258
|
"x-f5xc-example": "true",
|
|
12259
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
11690
12260
|
"x-f5xc-required-for": {
|
|
11691
12261
|
"minimum_config": false,
|
|
11692
12262
|
"create": false,
|
|
@@ -11701,6 +12271,8 @@
|
|
|
11701
12271
|
"x-displayname": "Labels",
|
|
11702
12272
|
"x-ves-example": "Value",
|
|
11703
12273
|
"x-f5xc-example": "value",
|
|
12274
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
12275
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
11704
12276
|
"x-f5xc-required-for": {
|
|
11705
12277
|
"minimum_config": false,
|
|
11706
12278
|
"create": false,
|
|
@@ -11721,6 +12293,8 @@
|
|
|
11721
12293
|
"x-validation-rules": {
|
|
11722
12294
|
"ves.io.schema.rules.message.required": "true"
|
|
11723
12295
|
},
|
|
12296
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
12297
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
11724
12298
|
"minLength": 0,
|
|
11725
12299
|
"maxLength": 16,
|
|
11726
12300
|
"x-f5xc-required-for": {
|
|
@@ -11731,7 +12305,7 @@
|
|
|
11731
12305
|
},
|
|
11732
12306
|
"x-original-maxLength": 1024,
|
|
11733
12307
|
"x-reconciled-from-discovery": true,
|
|
11734
|
-
"x-reconciled-at": "2026-01-
|
|
12308
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963515+00:00"
|
|
11735
12309
|
},
|
|
11736
12310
|
"namespace": {
|
|
11737
12311
|
"type": "string",
|
|
@@ -11740,6 +12314,8 @@
|
|
|
11740
12314
|
"x-displayname": "Namespace",
|
|
11741
12315
|
"x-ves-example": "Staging",
|
|
11742
12316
|
"x-f5xc-example": "staging",
|
|
12317
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
12318
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
11743
12319
|
"minLength": 0,
|
|
11744
12320
|
"maxLength": 6,
|
|
11745
12321
|
"x-f5xc-required-for": {
|
|
@@ -11750,9 +12326,10 @@
|
|
|
11750
12326
|
},
|
|
11751
12327
|
"x-original-maxLength": 1024,
|
|
11752
12328
|
"x-reconciled-from-discovery": true,
|
|
11753
|
-
"x-reconciled-at": "2026-01-
|
|
12329
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963521+00:00"
|
|
11754
12330
|
}
|
|
11755
12331
|
},
|
|
12332
|
+
"x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
|
|
11756
12333
|
"x-f5xc-minimum-configuration": {
|
|
11757
12334
|
"description": "Minimum configuration for schemaObjectReplaceMetaType",
|
|
11758
12335
|
"required_fields": [
|
|
@@ -11788,6 +12365,7 @@
|
|
|
11788
12365
|
"$ref": "#/components/schemas/schemaAuthnTypeQueryParams"
|
|
11789
12366
|
}
|
|
11790
12367
|
},
|
|
12368
|
+
"x-f5xc-description-short": "Authentication parameters for REST based hosts.",
|
|
11791
12369
|
"x-f5xc-minimum-configuration": {
|
|
11792
12370
|
"description": "Minimum configuration for schemaRestAuthInfoType",
|
|
11793
12371
|
"required_fields": [
|
|
@@ -11811,6 +12389,8 @@
|
|
|
11811
12389
|
"EncodingBase64"
|
|
11812
12390
|
],
|
|
11813
12391
|
"default": "EncodingNone",
|
|
12392
|
+
"x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
|
|
12393
|
+
"x-f5xc-description-medium": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. - EncodingNone: x-displayName: \"None\" No Encoding - EncodingBase64: Base64 x-displayName: \"Base64\" Base64 encoding.",
|
|
11814
12394
|
"x-f5xc-minimum-configuration": {
|
|
11815
12395
|
"description": "Minimum configuration for schemaSecretEncodingType",
|
|
11816
12396
|
"required_fields": [],
|
|
@@ -11836,6 +12416,7 @@
|
|
|
11836
12416
|
"$ref": "#/components/schemas/schemaClearSecretInfoType"
|
|
11837
12417
|
}
|
|
11838
12418
|
},
|
|
12419
|
+
"x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
|
|
11839
12420
|
"x-f5xc-minimum-configuration": {
|
|
11840
12421
|
"description": "Minimum configuration for schemaSecretType",
|
|
11841
12422
|
"required_fields": [
|
|
@@ -11892,6 +12473,7 @@
|
|
|
11892
12473
|
}
|
|
11893
12474
|
}
|
|
11894
12475
|
},
|
|
12476
|
+
"x-f5xc-description-short": "Specifies a direct reference to a site configuration object.",
|
|
11895
12477
|
"x-f5xc-minimum-configuration": {
|
|
11896
12478
|
"description": "Minimum configuration for schemaSiteRefType",
|
|
11897
12479
|
"required_fields": [
|
|
@@ -11920,6 +12502,8 @@
|
|
|
11920
12502
|
"title": "Creation_timestamp.",
|
|
11921
12503
|
"format": "date-time",
|
|
11922
12504
|
"x-displayname": "Creation Timestamp.",
|
|
12505
|
+
"x-f5xc-description-short": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.",
|
|
12506
|
+
"x-f5xc-description-medium": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.",
|
|
11923
12507
|
"minLength": 0,
|
|
11924
12508
|
"maxLength": 1024,
|
|
11925
12509
|
"x-f5xc-required-for": {
|
|
@@ -11937,6 +12521,8 @@
|
|
|
11937
12521
|
"x-displayname": "Creator Class.",
|
|
11938
12522
|
"x-ves-example": "ver.re1.int.ves.I/O.",
|
|
11939
12523
|
"x-f5xc-example": "ver.re1.int.F5 XC",
|
|
12524
|
+
"x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
|
|
12525
|
+
"x-f5xc-description-medium": "Class of creator which created this StatusObject. This will be service's DNS FQDN. This will be set by the system based on client certificate information.",
|
|
11940
12526
|
"minLength": 0,
|
|
11941
12527
|
"maxLength": 1024,
|
|
11942
12528
|
"x-f5xc-required-for": {
|
|
@@ -11954,6 +12540,8 @@
|
|
|
11954
12540
|
"x-displayname": "Creator ID.",
|
|
11955
12541
|
"x-ves-example": "Ver-instance-1.",
|
|
11956
12542
|
"x-f5xc-example": "ver-instance-1",
|
|
12543
|
+
"x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
|
|
12544
|
+
"x-f5xc-description-medium": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.",
|
|
11957
12545
|
"minLength": 0,
|
|
11958
12546
|
"maxLength": 1024,
|
|
11959
12547
|
"x-f5xc-required-for": {
|
|
@@ -11972,6 +12560,8 @@
|
|
|
11972
12560
|
"description": "Status_id is a field used by the generator to distinguish (if necessary) between two status\nobjects for the same config object from the same site and same service and potentially same\ndaemon(creator-ID)",
|
|
11973
12561
|
"title": "Status_id",
|
|
11974
12562
|
"x-displayname": "Status ID",
|
|
12563
|
+
"x-f5xc-description-short": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site...",
|
|
12564
|
+
"x-f5xc-description-medium": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID).",
|
|
11975
12565
|
"minLength": 0,
|
|
11976
12566
|
"maxLength": 1024,
|
|
11977
12567
|
"x-f5xc-required-for": {
|
|
@@ -11989,6 +12579,7 @@
|
|
|
11989
12579
|
"x-displayname": "UID",
|
|
11990
12580
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
11991
12581
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
12582
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
|
|
11992
12583
|
"minLength": 0,
|
|
11993
12584
|
"maxLength": 36,
|
|
11994
12585
|
"x-f5xc-required-for": {
|
|
@@ -12001,13 +12592,14 @@
|
|
|
12001
12592
|
"x-original-maxLength": 1024,
|
|
12002
12593
|
"format": "uuid",
|
|
12003
12594
|
"x-reconciled-from-discovery": true,
|
|
12004
|
-
"x-reconciled-at": "2026-01-
|
|
12595
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963547+00:00"
|
|
12005
12596
|
},
|
|
12006
12597
|
"vtrp_id": {
|
|
12007
12598
|
"type": "string",
|
|
12008
12599
|
"description": "Origin of this status exchanged by VTRP.",
|
|
12009
12600
|
"title": "Vtrp_id",
|
|
12010
12601
|
"x-displayname": "VTRP ID",
|
|
12602
|
+
"x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
|
|
12011
12603
|
"minLength": 0,
|
|
12012
12604
|
"maxLength": 1024,
|
|
12013
12605
|
"x-f5xc-required-for": {
|
|
@@ -12024,6 +12616,7 @@
|
|
|
12024
12616
|
"title": "Vtrp_stale.",
|
|
12025
12617
|
"format": "boolean",
|
|
12026
12618
|
"x-displayname": "VTRP Stale.",
|
|
12619
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
12027
12620
|
"x-f5xc-required-for": {
|
|
12028
12621
|
"minimum_config": false,
|
|
12029
12622
|
"create": false,
|
|
@@ -12032,6 +12625,7 @@
|
|
|
12032
12625
|
}
|
|
12033
12626
|
}
|
|
12034
12627
|
},
|
|
12628
|
+
"x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
|
|
12035
12629
|
"x-f5xc-minimum-configuration": {
|
|
12036
12630
|
"description": "Minimum configuration for schemaStatusMetaType",
|
|
12037
12631
|
"required_fields": [
|
|
@@ -12062,6 +12656,8 @@
|
|
|
12062
12656
|
"default": "STATUS_DO_NOT_PUBLISH",
|
|
12063
12657
|
"x-displayname": "Status Publish Type.",
|
|
12064
12658
|
"x-ves-proto-enum": "ves.io.schema.StatusPublishType",
|
|
12659
|
+
"x-f5xc-description-short": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user.",
|
|
12660
|
+
"x-f5xc-description-medium": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user. This could be because status is only informational - STATUS_PUBLISH: Publish Propagate this status up to user as it might be actionable.",
|
|
12065
12661
|
"x-f5xc-minimum-configuration": {
|
|
12066
12662
|
"description": "Minimum configuration for schemaStatusPublishType",
|
|
12067
12663
|
"required_fields": [],
|
|
@@ -12087,6 +12683,7 @@
|
|
|
12087
12683
|
"x-displayname": "Code",
|
|
12088
12684
|
"x-ves-example": "0",
|
|
12089
12685
|
"x-f5xc-example": "0",
|
|
12686
|
+
"x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
|
|
12090
12687
|
"minimum": 0,
|
|
12091
12688
|
"maximum": 2147483647,
|
|
12092
12689
|
"x-f5xc-required-for": {
|
|
@@ -12103,6 +12700,8 @@
|
|
|
12103
12700
|
"x-displayname": "Reason",
|
|
12104
12701
|
"x-ves-example": "Value",
|
|
12105
12702
|
"x-f5xc-example": "value",
|
|
12703
|
+
"x-f5xc-description-short": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.",
|
|
12704
|
+
"x-f5xc-description-medium": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.",
|
|
12106
12705
|
"minLength": 0,
|
|
12107
12706
|
"maxLength": 43,
|
|
12108
12707
|
"x-f5xc-required-for": {
|
|
@@ -12113,7 +12712,7 @@
|
|
|
12113
12712
|
},
|
|
12114
12713
|
"x-original-maxLength": 1024,
|
|
12115
12714
|
"x-reconciled-from-discovery": true,
|
|
12116
|
-
"x-reconciled-at": "2026-01-
|
|
12715
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963558+00:00"
|
|
12117
12716
|
},
|
|
12118
12717
|
"status": {
|
|
12119
12718
|
"type": "string",
|
|
@@ -12122,6 +12721,7 @@
|
|
|
12122
12721
|
"x-displayname": "Status",
|
|
12123
12722
|
"x-ves-example": "Value",
|
|
12124
12723
|
"x-f5xc-example": "value",
|
|
12724
|
+
"x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
|
|
12125
12725
|
"minLength": 0,
|
|
12126
12726
|
"maxLength": 17,
|
|
12127
12727
|
"x-f5xc-required-for": {
|
|
@@ -12132,9 +12732,10 @@
|
|
|
12132
12732
|
},
|
|
12133
12733
|
"x-original-maxLength": 1024,
|
|
12134
12734
|
"x-reconciled-from-discovery": true,
|
|
12135
|
-
"x-reconciled-at": "2026-01-
|
|
12735
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963562+00:00"
|
|
12136
12736
|
}
|
|
12137
12737
|
},
|
|
12738
|
+
"x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
|
|
12138
12739
|
"x-f5xc-minimum-configuration": {
|
|
12139
12740
|
"description": "Minimum configuration for schemaStatusType",
|
|
12140
12741
|
"required_fields": [
|
|
@@ -12162,6 +12763,8 @@
|
|
|
12162
12763
|
"title": "Creation_timestamp.",
|
|
12163
12764
|
"format": "date-time",
|
|
12164
12765
|
"x-displayname": "Creation Timestamp.",
|
|
12766
|
+
"x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
|
|
12767
|
+
"x-f5xc-description-medium": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value.",
|
|
12165
12768
|
"minLength": 0,
|
|
12166
12769
|
"maxLength": 1024,
|
|
12167
12770
|
"x-f5xc-required-for": {
|
|
@@ -12179,6 +12782,7 @@
|
|
|
12179
12782
|
"x-displayname": "Creator Class.",
|
|
12180
12783
|
"x-ves-example": "Prism",
|
|
12181
12784
|
"x-f5xc-example": "value",
|
|
12785
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
12182
12786
|
"minLength": 0,
|
|
12183
12787
|
"maxLength": 1024,
|
|
12184
12788
|
"x-f5xc-required-for": {
|
|
@@ -12196,6 +12800,7 @@
|
|
|
12196
12800
|
"x-displayname": "Creator ID.",
|
|
12197
12801
|
"x-ves-example": "Admin@example-corp.com.",
|
|
12198
12802
|
"x-f5xc-example": "value",
|
|
12803
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
12199
12804
|
"minLength": 0,
|
|
12200
12805
|
"maxLength": 1024,
|
|
12201
12806
|
"x-f5xc-required-for": {
|
|
@@ -12212,6 +12817,8 @@
|
|
|
12212
12817
|
"title": "Deletion_timestamp.",
|
|
12213
12818
|
"format": "date-time",
|
|
12214
12819
|
"x-displayname": "Deletion Timestamp.",
|
|
12820
|
+
"x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
|
|
12821
|
+
"x-f5xc-description-medium": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not...",
|
|
12215
12822
|
"minLength": 0,
|
|
12216
12823
|
"maxLength": 1024,
|
|
12217
12824
|
"x-f5xc-required-for": {
|
|
@@ -12231,6 +12838,8 @@
|
|
|
12231
12838
|
"x-displayname": "Finalizers.",
|
|
12232
12839
|
"x-ves-example": "Value",
|
|
12233
12840
|
"x-f5xc-example": "value",
|
|
12841
|
+
"x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
|
|
12842
|
+
"x-f5xc-description-medium": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.",
|
|
12234
12843
|
"x-f5xc-required-for": {
|
|
12235
12844
|
"minimum_config": false,
|
|
12236
12845
|
"create": false,
|
|
@@ -12248,6 +12857,8 @@
|
|
|
12248
12857
|
"x-displayname": "Labels",
|
|
12249
12858
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
12250
12859
|
"x-f5xc-example": "'F5 XC/soft-deleted''true'",
|
|
12860
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software.",
|
|
12861
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).",
|
|
12251
12862
|
"x-f5xc-required-for": {
|
|
12252
12863
|
"minimum_config": false,
|
|
12253
12864
|
"create": false,
|
|
@@ -12261,6 +12872,8 @@
|
|
|
12261
12872
|
"title": "Modification_timestamp.",
|
|
12262
12873
|
"format": "date-time",
|
|
12263
12874
|
"x-displayname": "Modification Timestamp.",
|
|
12875
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
12876
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
12264
12877
|
"minLength": 0,
|
|
12265
12878
|
"maxLength": 1024,
|
|
12266
12879
|
"x-f5xc-required-for": {
|
|
@@ -12279,6 +12892,8 @@
|
|
|
12279
12892
|
"x-displayname": "Object Index.",
|
|
12280
12893
|
"x-ves-example": "0",
|
|
12281
12894
|
"x-f5xc-example": "0",
|
|
12895
|
+
"x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
|
|
12896
|
+
"x-f5xc-description-medium": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.",
|
|
12282
12897
|
"minimum": 0,
|
|
12283
12898
|
"maximum": 2147483647,
|
|
12284
12899
|
"x-f5xc-required-for": {
|
|
@@ -12299,6 +12914,8 @@
|
|
|
12299
12914
|
"x-displayname": "Tenant",
|
|
12300
12915
|
"x-ves-example": "Example-corp.",
|
|
12301
12916
|
"x-f5xc-example": "example-corp",
|
|
12917
|
+
"x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
12918
|
+
"x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
12302
12919
|
"minLength": 0,
|
|
12303
12920
|
"maxLength": 18,
|
|
12304
12921
|
"x-f5xc-required-for": {
|
|
@@ -12310,7 +12927,7 @@
|
|
|
12310
12927
|
"x-field-mutability": "read-only",
|
|
12311
12928
|
"x-original-maxLength": 1024,
|
|
12312
12929
|
"x-reconciled-from-discovery": true,
|
|
12313
|
-
"x-reconciled-at": "2026-01-
|
|
12930
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963581+00:00"
|
|
12314
12931
|
},
|
|
12315
12932
|
"uid": {
|
|
12316
12933
|
"type": "string",
|
|
@@ -12319,6 +12936,8 @@
|
|
|
12319
12936
|
"x-displayname": "UID",
|
|
12320
12937
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
12321
12938
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
12939
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
|
|
12940
|
+
"x-f5xc-description-medium": "Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.",
|
|
12322
12941
|
"minLength": 0,
|
|
12323
12942
|
"maxLength": 36,
|
|
12324
12943
|
"x-f5xc-required-for": {
|
|
@@ -12331,9 +12950,11 @@
|
|
|
12331
12950
|
"x-original-maxLength": 1024,
|
|
12332
12951
|
"format": "uuid",
|
|
12333
12952
|
"x-reconciled-from-discovery": true,
|
|
12334
|
-
"x-reconciled-at": "2026-01-
|
|
12953
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963586+00:00"
|
|
12335
12954
|
}
|
|
12336
12955
|
},
|
|
12956
|
+
"x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
12957
|
+
"x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
12337
12958
|
"x-f5xc-minimum-configuration": {
|
|
12338
12959
|
"description": "Minimum configuration for schemaSystemObjectGetMetaType",
|
|
12339
12960
|
"required_fields": [
|
|
@@ -12387,6 +13008,8 @@
|
|
|
12387
13008
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
12388
13009
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
12389
13010
|
},
|
|
13011
|
+
"x-f5xc-description-short": "TLS certificate. Certificate or certificate chain in PEM format including the PEM headers.",
|
|
13012
|
+
"x-f5xc-description-medium": "TLS certificate. Certificate or certificate chain in PEM format including the PEM headers. Required: YES.",
|
|
12390
13013
|
"x-f5xc-required-for": {
|
|
12391
13014
|
"minimum_config": false,
|
|
12392
13015
|
"create": false,
|
|
@@ -12414,7 +13037,7 @@
|
|
|
12414
13037
|
},
|
|
12415
13038
|
"x-original-maxLength": 1024,
|
|
12416
13039
|
"x-reconciled-from-discovery": true,
|
|
12417
|
-
"x-reconciled-at": "2026-01-
|
|
13040
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963594+00:00"
|
|
12418
13041
|
},
|
|
12419
13042
|
"disable_ocsp_stapling": {
|
|
12420
13043
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
@@ -12469,6 +13092,8 @@
|
|
|
12469
13092
|
"ves.io.schema.rules.repeated.items.string.in": "[\\\"TLS_AES_128_GCM_SHA256\\\",\\\"TLS_AES_256_GCM_SHA384\\\",\\\"TLS_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_256_GCM_SHA384\\\"]",
|
|
12470
13093
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
12471
13094
|
},
|
|
13095
|
+
"x-f5xc-description-short": "The following list specifies the supported cipher suite TLS_AES_128_GCM_SHA256 TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256...",
|
|
13096
|
+
"x-f5xc-description-medium": "The following list specifies the supported cipher suite TLS_AES_128_GCM_SHA256 TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256...",
|
|
12472
13097
|
"x-f5xc-required-for": {
|
|
12473
13098
|
"minimum_config": false,
|
|
12474
13099
|
"create": false,
|
|
@@ -12501,6 +13126,8 @@
|
|
|
12501
13126
|
"$ref": "#/components/schemas/schemaTlsValidationParamsType"
|
|
12502
13127
|
}
|
|
12503
13128
|
},
|
|
13129
|
+
"x-f5xc-description-short": "Information of different aspects for TLS authentication related to ciphers, certificates and trust store.",
|
|
13130
|
+
"x-f5xc-description-medium": "Information of different aspects for TLS authentication related to ciphers, certificates and trust store.",
|
|
12504
13131
|
"x-f5xc-minimum-configuration": {
|
|
12505
13132
|
"description": "Minimum configuration for schemaTlsParamsType",
|
|
12506
13133
|
"required_fields": [
|
|
@@ -12531,6 +13158,8 @@
|
|
|
12531
13158
|
"default": "TLS_AUTO",
|
|
12532
13159
|
"x-displayname": "TLS Protocol.",
|
|
12533
13160
|
"x-ves-proto-enum": "ves.io.schema.TlsProtocol",
|
|
13161
|
+
"x-f5xc-description-short": "TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version.",
|
|
13162
|
+
"x-f5xc-description-medium": "TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version.",
|
|
12534
13163
|
"x-f5xc-minimum-configuration": {
|
|
12535
13164
|
"description": "Minimum configuration for schemaTlsProtocol",
|
|
12536
13165
|
"required_fields": [],
|
|
@@ -12555,6 +13184,9 @@
|
|
|
12555
13184
|
"title": "Skip_hostname_verification.",
|
|
12556
13185
|
"format": "boolean",
|
|
12557
13186
|
"x-displayname": "Skip verification of hostname.",
|
|
13187
|
+
"x-f5xc-example": "example-resource",
|
|
13188
|
+
"x-f5xc-description-short": "When True, skip verification of hostname i.e. CN/Subject Alt Name of certificate is not matched to the connecting hostname.",
|
|
13189
|
+
"x-f5xc-description-medium": "When True, skip verification of hostname i.e. CN/Subject Alt Name of certificate is not matched to the connecting hostname.",
|
|
12558
13190
|
"x-f5xc-required-for": {
|
|
12559
13191
|
"minimum_config": false,
|
|
12560
13192
|
"create": false,
|
|
@@ -12579,6 +13211,7 @@
|
|
|
12579
13211
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
12580
13212
|
"ves.io.schema.rules.string.truststore_url": "true"
|
|
12581
13213
|
},
|
|
13214
|
+
"x-f5xc-description-short": "Exclusive with [trusted_ca] Inline Root CA Certificate.",
|
|
12582
13215
|
"minLength": 0,
|
|
12583
13216
|
"x-f5xc-required-for": {
|
|
12584
13217
|
"minimum_config": false,
|
|
@@ -12597,6 +13230,8 @@
|
|
|
12597
13230
|
"x-displayname": "List of SANs for matching.",
|
|
12598
13231
|
"x-ves-example": "Value",
|
|
12599
13232
|
"x-f5xc-example": "value",
|
|
13233
|
+
"x-f5xc-description-short": "List of acceptable Subject Alt Names/CN in the peer's certificate.",
|
|
13234
|
+
"x-f5xc-description-medium": "List of acceptable Subject Alt Names/CN in the peer's certificate. When skip_hostname_verification is false and verify_subject_alt_names is empty, the hostname of the peer will be used for matching against SAN/CN of peer's certificate.",
|
|
12600
13235
|
"x-f5xc-required-for": {
|
|
12601
13236
|
"minimum_config": false,
|
|
12602
13237
|
"create": false,
|
|
@@ -12605,6 +13240,8 @@
|
|
|
12605
13240
|
}
|
|
12606
13241
|
}
|
|
12607
13242
|
},
|
|
13243
|
+
"x-f5xc-description-short": "Includes URL for a trust store, whether SAN verification is required and list of Subject Alt Names for verification.",
|
|
13244
|
+
"x-f5xc-description-medium": "Includes URL for a trust store, whether SAN verification is required and list of Subject Alt Names for verification.",
|
|
12608
13245
|
"x-f5xc-minimum-configuration": {
|
|
12609
13246
|
"description": "Minimum configuration for schemaTlsValidationParamsType",
|
|
12610
13247
|
"required_fields": [
|
|
@@ -12673,6 +13310,7 @@
|
|
|
12673
13310
|
"default": "HTTP",
|
|
12674
13311
|
"x-displayname": "URL Scheme.",
|
|
12675
13312
|
"x-ves-proto-enum": "ves.io.schema.URLSchemeType",
|
|
13313
|
+
"x-f5xc-description-short": "SchemeType is used to indicate URL scheme HTTP:// scheme HTTPS:// scheme.",
|
|
12676
13314
|
"x-f5xc-minimum-configuration": {
|
|
12677
13315
|
"description": "Minimum configuration for schemaURLSchemeType",
|
|
12678
13316
|
"required_fields": [],
|
|
@@ -12710,6 +13348,7 @@
|
|
|
12710
13348
|
"ves.io.schema.rules.string.max_len": "1",
|
|
12711
13349
|
"ves.io.schema.rules.string.min_len": "1"
|
|
12712
13350
|
},
|
|
13351
|
+
"x-f5xc-description-short": "Client TLS Certificate required for mTLS authentication Required: YES.",
|
|
12713
13352
|
"x-f5xc-required-for": {
|
|
12714
13353
|
"minimum_config": false,
|
|
12715
13354
|
"create": false,
|
|
@@ -12735,6 +13374,8 @@
|
|
|
12735
13374
|
"ves.io.schema.rules.repeated.items.string.in": "[\\\"TLS_AES_128_GCM_SHA256\\\",\\\"TLS_AES_256_GCM_SHA384\\\",\\\"TLS_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_256_GCM_SHA384\\\"]",
|
|
12736
13375
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
12737
13376
|
},
|
|
13377
|
+
"x-f5xc-description-short": "The following list specifies the supported cipher suite TLS_AES_128_GCM_SHA256 TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256...",
|
|
13378
|
+
"x-f5xc-description-medium": "The following list specifies the supported cipher suite TLS_AES_128_GCM_SHA256 TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256...",
|
|
12738
13379
|
"x-f5xc-required-for": {
|
|
12739
13380
|
"minimum_config": false,
|
|
12740
13381
|
"create": false,
|
|
@@ -12752,6 +13393,7 @@
|
|
|
12752
13393
|
"$ref": "#/components/schemas/schemaTlsValidationParamsType"
|
|
12753
13394
|
}
|
|
12754
13395
|
},
|
|
13396
|
+
"x-f5xc-description-short": "Certificate Parameters for authentication, TLS ciphers, and trust store.",
|
|
12755
13397
|
"x-f5xc-minimum-configuration": {
|
|
12756
13398
|
"description": "Minimum configuration for schemaUpstreamCertificateParamsType",
|
|
12757
13399
|
"required_fields": [
|
|
@@ -12809,6 +13451,8 @@
|
|
|
12809
13451
|
"ves.io.schema.rules.uint32.gte": "2",
|
|
12810
13452
|
"ves.io.schema.rules.uint32.lte": "64"
|
|
12811
13453
|
},
|
|
13454
|
+
"x-f5xc-description-short": "Exclusive with [default_session_key_caching disable_session_key_caching] Number of session keys that are cached.",
|
|
13455
|
+
"x-f5xc-description-medium": "Exclusive with [default_session_key_caching disable_session_key_caching] Number of session keys that are cached.",
|
|
12812
13456
|
"minimum": 0,
|
|
12813
13457
|
"maximum": 2147483647,
|
|
12814
13458
|
"x-f5xc-required-for": {
|
|
@@ -12832,6 +13476,7 @@
|
|
|
12832
13476
|
"ves.io.schema.rules.string.hostname": "true",
|
|
12833
13477
|
"ves.io.schema.rules.string.max_len": "256"
|
|
12834
13478
|
},
|
|
13479
|
+
"x-f5xc-description-short": "Exclusive with [disable_sni use_host_header_as_sni] SNI value to be used.",
|
|
12835
13480
|
"minLength": 0,
|
|
12836
13481
|
"x-f5xc-required-for": {
|
|
12837
13482
|
"minimum_config": false,
|
|
@@ -12844,6 +13489,7 @@
|
|
|
12844
13489
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
12845
13490
|
}
|
|
12846
13491
|
},
|
|
13492
|
+
"x-f5xc-description-short": "TLS configuration for upstream connections.",
|
|
12847
13493
|
"x-f5xc-minimum-configuration": {
|
|
12848
13494
|
"description": "Minimum configuration for schemaUpstreamTlsParamsType",
|
|
12849
13495
|
"required_fields": [
|
|
@@ -12898,6 +13544,7 @@
|
|
|
12898
13544
|
"ves.io.schema.rules.message.required": "true",
|
|
12899
13545
|
"ves.io.schema.rules.repeated.max_items": "1"
|
|
12900
13546
|
},
|
|
13547
|
+
"x-f5xc-description-short": "Virtual_site direct reference Required: YES.",
|
|
12901
13548
|
"x-f5xc-required-for": {
|
|
12902
13549
|
"minimum_config": false,
|
|
12903
13550
|
"create": false,
|
|
@@ -12936,6 +13583,7 @@
|
|
|
12936
13583
|
"$ref": "#/components/schemas/schemaSecretType"
|
|
12937
13584
|
}
|
|
12938
13585
|
},
|
|
13586
|
+
"x-f5xc-description-short": "Authentication parameters for Hashicorp Vault hosts.",
|
|
12939
13587
|
"x-f5xc-minimum-configuration": {
|
|
12940
13588
|
"description": "Minimum configuration for schemaVaultAuthInfoType",
|
|
12941
13589
|
"required_fields": [
|
|
@@ -12959,6 +13607,8 @@
|
|
|
12959
13607
|
"description": "X-displayName: \"Key\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.",
|
|
12960
13608
|
"title": "Key",
|
|
12961
13609
|
"x-f5xc-example": "key_pem",
|
|
13610
|
+
"x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
|
|
13611
|
+
"x-f5xc-description-medium": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key.",
|
|
12962
13612
|
"minLength": 0,
|
|
12963
13613
|
"maxLength": 16,
|
|
12964
13614
|
"x-f5xc-required-for": {
|
|
@@ -12969,13 +13619,14 @@
|
|
|
12969
13619
|
},
|
|
12970
13620
|
"x-original-maxLength": 1024,
|
|
12971
13621
|
"x-reconciled-from-discovery": true,
|
|
12972
|
-
"x-reconciled-at": "2026-01-
|
|
13622
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963643+00:00"
|
|
12973
13623
|
},
|
|
12974
13624
|
"location": {
|
|
12975
13625
|
"type": "string",
|
|
12976
13626
|
"description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
|
|
12977
13627
|
"title": "Location",
|
|
12978
13628
|
"x-f5xc-example": "v1/data/vhost_key",
|
|
13629
|
+
"x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
|
|
12979
13630
|
"minLength": 0,
|
|
12980
13631
|
"maxLength": 4,
|
|
12981
13632
|
"x-f5xc-required-for": {
|
|
@@ -12986,13 +13637,15 @@
|
|
|
12986
13637
|
},
|
|
12987
13638
|
"x-original-maxLength": 1024,
|
|
12988
13639
|
"x-reconciled-from-discovery": true,
|
|
12989
|
-
"x-reconciled-at": "2026-01-
|
|
13640
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963647+00:00"
|
|
12990
13641
|
},
|
|
12991
13642
|
"provider": {
|
|
12992
13643
|
"type": "string",
|
|
12993
13644
|
"description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
|
|
12994
13645
|
"title": "Provider",
|
|
12995
13646
|
"x-f5xc-example": "vault-vh-provider",
|
|
13647
|
+
"x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
13648
|
+
"x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
12996
13649
|
"minLength": 0,
|
|
12997
13650
|
"maxLength": 8,
|
|
12998
13651
|
"x-f5xc-required-for": {
|
|
@@ -13003,7 +13656,7 @@
|
|
|
13003
13656
|
},
|
|
13004
13657
|
"x-original-maxLength": 1024,
|
|
13005
13658
|
"x-reconciled-from-discovery": true,
|
|
13006
|
-
"x-reconciled-at": "2026-01-
|
|
13659
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963652+00:00"
|
|
13007
13660
|
},
|
|
13008
13661
|
"secret_encoding": {
|
|
13009
13662
|
"$ref": "#/components/schemas/schemaSecretEncodingType"
|
|
@@ -13014,6 +13667,8 @@
|
|
|
13014
13667
|
"title": "Version",
|
|
13015
13668
|
"format": "int64",
|
|
13016
13669
|
"x-f5xc-example": "1",
|
|
13670
|
+
"x-f5xc-description-short": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.",
|
|
13671
|
+
"x-f5xc-description-medium": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.",
|
|
13017
13672
|
"minimum": 0,
|
|
13018
13673
|
"maximum": 2147483647,
|
|
13019
13674
|
"x-f5xc-required-for": {
|
|
@@ -13025,9 +13680,11 @@
|
|
|
13025
13680
|
"maxLength": 1,
|
|
13026
13681
|
"minLength": 1,
|
|
13027
13682
|
"x-reconciled-from-discovery": true,
|
|
13028
|
-
"x-reconciled-at": "2026-01-
|
|
13683
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963659+00:00"
|
|
13029
13684
|
}
|
|
13030
13685
|
},
|
|
13686
|
+
"x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
13687
|
+
"x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
13031
13688
|
"x-f5xc-minimum-configuration": {
|
|
13032
13689
|
"description": "Minimum configuration for schemaVaultSecretInfoType",
|
|
13033
13690
|
"required_fields": [
|
|
@@ -13068,7 +13725,7 @@
|
|
|
13068
13725
|
},
|
|
13069
13726
|
"x-original-maxLength": 1024,
|
|
13070
13727
|
"x-reconciled-from-discovery": true,
|
|
13071
|
-
"x-reconciled-at": "2026-01-
|
|
13728
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963665+00:00"
|
|
13072
13729
|
},
|
|
13073
13730
|
"name": {
|
|
13074
13731
|
"type": "string",
|
|
@@ -13077,6 +13734,8 @@
|
|
|
13077
13734
|
"x-displayname": "Name",
|
|
13078
13735
|
"x-ves-example": "Contactus-route.",
|
|
13079
13736
|
"x-f5xc-example": "contactus-route",
|
|
13737
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
|
|
13738
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
|
|
13080
13739
|
"minLength": 0,
|
|
13081
13740
|
"maxLength": 16,
|
|
13082
13741
|
"x-f5xc-required-for": {
|
|
@@ -13087,7 +13746,7 @@
|
|
|
13087
13746
|
},
|
|
13088
13747
|
"x-original-maxLength": 1024,
|
|
13089
13748
|
"x-reconciled-from-discovery": true,
|
|
13090
|
-
"x-reconciled-at": "2026-01-
|
|
13749
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963669+00:00"
|
|
13091
13750
|
},
|
|
13092
13751
|
"namespace": {
|
|
13093
13752
|
"type": "string",
|
|
@@ -13096,6 +13755,8 @@
|
|
|
13096
13755
|
"x-displayname": "Namespace",
|
|
13097
13756
|
"x-ves-example": "Ns1",
|
|
13098
13757
|
"x-f5xc-example": "ns1",
|
|
13758
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
|
|
13759
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
|
|
13099
13760
|
"minLength": 0,
|
|
13100
13761
|
"maxLength": 6,
|
|
13101
13762
|
"x-f5xc-required-for": {
|
|
@@ -13106,7 +13767,7 @@
|
|
|
13106
13767
|
},
|
|
13107
13768
|
"x-original-maxLength": 1024,
|
|
13108
13769
|
"x-reconciled-from-discovery": true,
|
|
13109
|
-
"x-reconciled-at": "2026-01-
|
|
13770
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963673+00:00"
|
|
13110
13771
|
},
|
|
13111
13772
|
"uid": {
|
|
13112
13773
|
"type": "string",
|
|
@@ -13127,9 +13788,10 @@
|
|
|
13127
13788
|
"x-original-maxLength": 1024,
|
|
13128
13789
|
"format": "uuid",
|
|
13129
13790
|
"x-reconciled-from-discovery": true,
|
|
13130
|
-
"x-reconciled-at": "2026-01-
|
|
13791
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963678+00:00"
|
|
13131
13792
|
}
|
|
13132
13793
|
},
|
|
13794
|
+
"x-f5xc-description-short": "ViewRefType represents a reference to a view.",
|
|
13133
13795
|
"x-f5xc-minimum-configuration": {
|
|
13134
13796
|
"description": "Minimum configuration for schemaViewRefType",
|
|
13135
13797
|
"required_fields": [
|
|
@@ -13167,6 +13829,8 @@
|
|
|
13167
13829
|
"default": "VIRTUAL_NETWORK_SITE_LOCAL",
|
|
13168
13830
|
"x-displayname": "Virtual Network Type.",
|
|
13169
13831
|
"x-ves-proto-enum": "ves.io.schema.VirtualNetworkType",
|
|
13832
|
+
"x-f5xc-description-short": "Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public...",
|
|
13833
|
+
"x-f5xc-description-medium": "Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network. This is an insecure network and is connected to public internet via NAT Gateways/firwalls Virtual-network of this type is local to...",
|
|
13170
13834
|
"x-f5xc-minimum-configuration": {
|
|
13171
13835
|
"description": "Minimum configuration for schemaVirtualNetworkType",
|
|
13172
13836
|
"required_fields": [],
|
|
@@ -13187,6 +13851,7 @@
|
|
|
13187
13851
|
"description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
|
|
13188
13852
|
"title": "Name",
|
|
13189
13853
|
"x-f5xc-example": "ChargeBack-API-Key",
|
|
13854
|
+
"x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
|
|
13190
13855
|
"minLength": 0,
|
|
13191
13856
|
"maxLength": 16,
|
|
13192
13857
|
"x-f5xc-required-for": {
|
|
@@ -13197,9 +13862,10 @@
|
|
|
13197
13862
|
},
|
|
13198
13863
|
"x-original-maxLength": 1024,
|
|
13199
13864
|
"x-reconciled-from-discovery": true,
|
|
13200
|
-
"x-reconciled-at": "2026-01-
|
|
13865
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963683+00:00"
|
|
13201
13866
|
}
|
|
13202
13867
|
},
|
|
13868
|
+
"x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
|
|
13203
13869
|
"x-f5xc-minimum-configuration": {
|
|
13204
13870
|
"description": "Minimum configuration for schemaWingmanSecretInfoType",
|
|
13205
13871
|
"required_fields": [
|
|
@@ -13297,6 +13963,8 @@
|
|
|
13297
13963
|
"ves.io.schema.rules.string.max_len": "256",
|
|
13298
13964
|
"ves.io.schema.rules.string.min_len": "1"
|
|
13299
13965
|
},
|
|
13966
|
+
"x-f5xc-description-short": "Name given to this secret management backend. site.provider needs to be unique, and will be referenced for using this object Required: YES.",
|
|
13967
|
+
"x-f5xc-description-medium": "Name given to this secret management backend. site.provider needs to be unique, and will be referenced for using this object Required: YES.",
|
|
13300
13968
|
"x-f5xc-required-for": {
|
|
13301
13969
|
"minimum_config": false,
|
|
13302
13970
|
"create": false,
|
|
@@ -13308,6 +13976,7 @@
|
|
|
13308
13976
|
"$ref": "#/components/schemas/schemaNetworkSiteRefSelector"
|
|
13309
13977
|
}
|
|
13310
13978
|
},
|
|
13979
|
+
"x-f5xc-description-short": "Create secret_management_access creates a new object in storage backend for metadata.namespace.",
|
|
13311
13980
|
"x-f5xc-minimum-configuration": {
|
|
13312
13981
|
"description": "Minimum configuration for secret_management_accessCreateSpecType",
|
|
13313
13982
|
"required_fields": [
|
|
@@ -13335,6 +14004,7 @@
|
|
|
13335
14004
|
"title": "Fail_if_referred.",
|
|
13336
14005
|
"format": "boolean",
|
|
13337
14006
|
"x-displayname": "Fail-If-Referred.",
|
|
14007
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
13338
14008
|
"x-f5xc-required-for": {
|
|
13339
14009
|
"minimum_config": false,
|
|
13340
14010
|
"create": false,
|
|
@@ -13359,7 +14029,7 @@
|
|
|
13359
14029
|
},
|
|
13360
14030
|
"x-original-maxLength": 1024,
|
|
13361
14031
|
"x-reconciled-from-discovery": true,
|
|
13362
|
-
"x-reconciled-at": "2026-01-
|
|
14032
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963700+00:00"
|
|
13363
14033
|
},
|
|
13364
14034
|
"namespace": {
|
|
13365
14035
|
"type": "string",
|
|
@@ -13368,6 +14038,7 @@
|
|
|
13368
14038
|
"x-displayname": "Namespace",
|
|
13369
14039
|
"x-ves-example": "Ns1",
|
|
13370
14040
|
"x-f5xc-example": "ns1",
|
|
14041
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
13371
14042
|
"minLength": 0,
|
|
13372
14043
|
"maxLength": 6,
|
|
13373
14044
|
"x-f5xc-required-for": {
|
|
@@ -13378,7 +14049,7 @@
|
|
|
13378
14049
|
},
|
|
13379
14050
|
"x-original-maxLength": 1024,
|
|
13380
14051
|
"x-reconciled-from-discovery": true,
|
|
13381
|
-
"x-reconciled-at": "2026-01-
|
|
14052
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963704+00:00"
|
|
13382
14053
|
}
|
|
13383
14054
|
},
|
|
13384
14055
|
"x-f5xc-minimum-configuration": {
|
|
@@ -13413,6 +14084,7 @@
|
|
|
13413
14084
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
13414
14085
|
},
|
|
13415
14086
|
"x-displayname": "Deleted Referred Objects.",
|
|
14087
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
13416
14088
|
"x-f5xc-required-for": {
|
|
13417
14089
|
"minimum_config": false,
|
|
13418
14090
|
"create": false,
|
|
@@ -13428,6 +14100,7 @@
|
|
|
13428
14100
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
13429
14101
|
},
|
|
13430
14102
|
"x-displayname": "Disabled Referred Objects.",
|
|
14103
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
13431
14104
|
"x-f5xc-required-for": {
|
|
13432
14105
|
"minimum_config": false,
|
|
13433
14106
|
"create": false,
|
|
@@ -13446,6 +14119,7 @@
|
|
|
13446
14119
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
13447
14120
|
},
|
|
13448
14121
|
"x-displayname": "Referring Objects.",
|
|
14122
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
13449
14123
|
"x-f5xc-required-for": {
|
|
13450
14124
|
"minimum_config": false,
|
|
13451
14125
|
"create": false,
|
|
@@ -13467,6 +14141,8 @@
|
|
|
13467
14141
|
"$ref": "#/components/schemas/secret_management_accessStatusObject"
|
|
13468
14142
|
},
|
|
13469
14143
|
"x-displayname": "Status",
|
|
14144
|
+
"x-f5xc-example": "active",
|
|
14145
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
13470
14146
|
"x-f5xc-required-for": {
|
|
13471
14147
|
"minimum_config": false,
|
|
13472
14148
|
"create": false,
|
|
@@ -13476,7 +14152,7 @@
|
|
|
13476
14152
|
"maxLength": 17,
|
|
13477
14153
|
"minLength": 17,
|
|
13478
14154
|
"x-reconciled-from-discovery": true,
|
|
13479
|
-
"x-reconciled-at": "2026-01-
|
|
14155
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963718+00:00"
|
|
13480
14156
|
},
|
|
13481
14157
|
"system_metadata": {
|
|
13482
14158
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -13516,6 +14192,8 @@
|
|
|
13516
14192
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
13517
14193
|
],
|
|
13518
14194
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
14195
|
+
"x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
|
|
14196
|
+
"x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
|
|
13519
14197
|
"x-f5xc-minimum-configuration": {
|
|
13520
14198
|
"description": "Minimum configuration for secret_management_accessGetResponseFormatCode",
|
|
13521
14199
|
"required_fields": [],
|
|
@@ -13556,6 +14234,8 @@
|
|
|
13556
14234
|
"ves.io.schema.rules.string.max_len": "256",
|
|
13557
14235
|
"ves.io.schema.rules.string.min_len": "1"
|
|
13558
14236
|
},
|
|
14237
|
+
"x-f5xc-description-short": "Name given to this secret management backend. site.provider needs to be unique, and will be referenced for using this object Required: YES.",
|
|
14238
|
+
"x-f5xc-description-medium": "Name given to this secret management backend. site.provider needs to be unique, and will be referenced for using this object Required: YES.",
|
|
13559
14239
|
"x-f5xc-required-for": {
|
|
13560
14240
|
"minimum_config": false,
|
|
13561
14241
|
"create": false,
|
|
@@ -13567,6 +14247,7 @@
|
|
|
13567
14247
|
"$ref": "#/components/schemas/schemaNetworkSiteRefSelector"
|
|
13568
14248
|
}
|
|
13569
14249
|
},
|
|
14250
|
+
"x-f5xc-description-short": "GET secret_management_access reads a given object from storage backend for metadata.namespace.",
|
|
13570
14251
|
"x-f5xc-minimum-configuration": {
|
|
13571
14252
|
"description": "Minimum configuration for secret_management_accessGetSpecType",
|
|
13572
14253
|
"required_fields": [
|
|
@@ -13596,6 +14277,7 @@
|
|
|
13596
14277
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
13597
14278
|
},
|
|
13598
14279
|
"x-displayname": "Errors",
|
|
14280
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
13599
14281
|
"x-f5xc-required-for": {
|
|
13600
14282
|
"minimum_config": false,
|
|
13601
14283
|
"create": false,
|
|
@@ -13611,6 +14293,8 @@
|
|
|
13611
14293
|
"$ref": "#/components/schemas/secret_management_accessListResponseItem"
|
|
13612
14294
|
},
|
|
13613
14295
|
"x-displayname": "Items",
|
|
14296
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
14297
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
13614
14298
|
"x-f5xc-required-for": {
|
|
13615
14299
|
"minimum_config": false,
|
|
13616
14300
|
"create": false,
|
|
@@ -13644,6 +14328,8 @@
|
|
|
13644
14328
|
"description": "The set of annotations present on this secret_management_access.",
|
|
13645
14329
|
"title": "Annotations.",
|
|
13646
14330
|
"x-displayname": "Annotations.",
|
|
14331
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
14332
|
+
"x-f5xc-description-short": "The set of annotations present on this secret_management_access.",
|
|
13647
14333
|
"x-f5xc-required-for": {
|
|
13648
14334
|
"minimum_config": false,
|
|
13649
14335
|
"create": false,
|
|
@@ -13656,6 +14342,7 @@
|
|
|
13656
14342
|
"description": "The description set for this secret_management_access.",
|
|
13657
14343
|
"title": "Description.",
|
|
13658
14344
|
"x-displayname": "Description.",
|
|
14345
|
+
"x-f5xc-description-short": "The description set for this secret_management_access.",
|
|
13659
14346
|
"minLength": 0,
|
|
13660
14347
|
"maxLength": 0,
|
|
13661
14348
|
"x-f5xc-required-for": {
|
|
@@ -13666,7 +14353,7 @@
|
|
|
13666
14353
|
},
|
|
13667
14354
|
"x-original-maxLength": 1024,
|
|
13668
14355
|
"x-reconciled-from-discovery": true,
|
|
13669
|
-
"x-reconciled-at": "2026-01-
|
|
14356
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963734+00:00"
|
|
13670
14357
|
},
|
|
13671
14358
|
"disabled": {
|
|
13672
14359
|
"type": "boolean",
|
|
@@ -13674,6 +14361,8 @@
|
|
|
13674
14361
|
"title": "Disabled",
|
|
13675
14362
|
"format": "boolean",
|
|
13676
14363
|
"x-displayname": "Disabled",
|
|
14364
|
+
"x-f5xc-example": "True",
|
|
14365
|
+
"x-f5xc-description-short": "Value of true indicates secret_management_access is administratively disabled.",
|
|
13677
14366
|
"x-f5xc-required-for": {
|
|
13678
14367
|
"minimum_config": false,
|
|
13679
14368
|
"create": false,
|
|
@@ -13689,6 +14378,8 @@
|
|
|
13689
14378
|
"description": "The set of labels present on this secret_management_access.",
|
|
13690
14379
|
"title": "Labels",
|
|
13691
14380
|
"x-displayname": "Labels",
|
|
14381
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
14382
|
+
"x-f5xc-description-short": "The set of labels present on this secret_management_access.",
|
|
13692
14383
|
"x-f5xc-required-for": {
|
|
13693
14384
|
"minimum_config": false,
|
|
13694
14385
|
"create": false,
|
|
@@ -13706,6 +14397,7 @@
|
|
|
13706
14397
|
"x-displayname": "Name",
|
|
13707
14398
|
"x-ves-example": "Name",
|
|
13708
14399
|
"x-f5xc-example": "name",
|
|
14400
|
+
"x-f5xc-description-short": "The name of this secret_management_access.",
|
|
13709
14401
|
"minLength": 0,
|
|
13710
14402
|
"maxLength": 16,
|
|
13711
14403
|
"x-f5xc-required-for": {
|
|
@@ -13716,7 +14408,7 @@
|
|
|
13716
14408
|
},
|
|
13717
14409
|
"x-original-maxLength": 1024,
|
|
13718
14410
|
"x-reconciled-from-discovery": true,
|
|
13719
|
-
"x-reconciled-at": "2026-01-
|
|
14411
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963744+00:00"
|
|
13720
14412
|
},
|
|
13721
14413
|
"namespace": {
|
|
13722
14414
|
"type": "string",
|
|
@@ -13735,7 +14427,7 @@
|
|
|
13735
14427
|
},
|
|
13736
14428
|
"x-original-maxLength": 1024,
|
|
13737
14429
|
"x-reconciled-from-discovery": true,
|
|
13738
|
-
"x-reconciled-at": "2026-01-
|
|
14430
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963749+00:00"
|
|
13739
14431
|
},
|
|
13740
14432
|
"owner_view": {
|
|
13741
14433
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -13748,6 +14440,7 @@
|
|
|
13748
14440
|
"$ref": "#/components/schemas/secret_management_accessStatusObject"
|
|
13749
14441
|
},
|
|
13750
14442
|
"x-displayname": "Status",
|
|
14443
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
13751
14444
|
"x-f5xc-required-for": {
|
|
13752
14445
|
"minimum_config": false,
|
|
13753
14446
|
"create": false,
|
|
@@ -13776,7 +14469,7 @@
|
|
|
13776
14469
|
"x-field-mutability": "read-only",
|
|
13777
14470
|
"x-original-maxLength": 1024,
|
|
13778
14471
|
"x-reconciled-from-discovery": true,
|
|
13779
|
-
"x-reconciled-at": "2026-01-
|
|
14472
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963756+00:00"
|
|
13780
14473
|
},
|
|
13781
14474
|
"uid": {
|
|
13782
14475
|
"type": "string",
|
|
@@ -13785,6 +14478,7 @@
|
|
|
13785
14478
|
"x-displayname": "UID",
|
|
13786
14479
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
13787
14480
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
14481
|
+
"x-f5xc-description-short": "The unique uid of this secret_management_access.",
|
|
13788
14482
|
"minLength": 0,
|
|
13789
14483
|
"maxLength": 36,
|
|
13790
14484
|
"x-f5xc-required-for": {
|
|
@@ -13797,9 +14491,11 @@
|
|
|
13797
14491
|
"x-original-maxLength": 1024,
|
|
13798
14492
|
"format": "uuid",
|
|
13799
14493
|
"x-reconciled-from-discovery": true,
|
|
13800
|
-
"x-reconciled-at": "2026-01-
|
|
14494
|
+
"x-reconciled-at": "2026-01-07T15:29:15.963761+00:00"
|
|
13801
14495
|
}
|
|
13802
14496
|
},
|
|
14497
|
+
"x-f5xc-description-short": "By default a summary of secret_management_access is returned in 'List'.",
|
|
14498
|
+
"x-f5xc-description-medium": "By default a summary of secret_management_access is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
13803
14499
|
"x-f5xc-minimum-configuration": {
|
|
13804
14500
|
"description": "Minimum configuration for secret_management_accessListResponseItem",
|
|
13805
14501
|
"required_fields": [
|
|
@@ -13894,6 +14590,8 @@
|
|
|
13894
14590
|
"ves.io.schema.rules.string.max_len": "256",
|
|
13895
14591
|
"ves.io.schema.rules.string.min_len": "1"
|
|
13896
14592
|
},
|
|
14593
|
+
"x-f5xc-description-short": "Name given to this secret management backend. site.provider needs to be unique, and will be referenced for using this object Required: YES.",
|
|
14594
|
+
"x-f5xc-description-medium": "Name given to this secret management backend. site.provider needs to be unique, and will be referenced for using this object Required: YES.",
|
|
13897
14595
|
"x-f5xc-required-for": {
|
|
13898
14596
|
"minimum_config": false,
|
|
13899
14597
|
"create": false,
|
|
@@ -13905,6 +14603,8 @@
|
|
|
13905
14603
|
"$ref": "#/components/schemas/schemaNetworkSiteRefSelector"
|
|
13906
14604
|
}
|
|
13907
14605
|
},
|
|
14606
|
+
"x-f5xc-description-short": "Replace secret_management_access replaces an existing object in storage backend for metadata.namespace.",
|
|
14607
|
+
"x-f5xc-description-medium": "Replace secret_management_access replaces an existing object in storage backend for metadata.namespace.",
|
|
13908
14608
|
"x-f5xc-minimum-configuration": {
|
|
13909
14609
|
"description": "Minimum configuration for secret_management_accessReplaceSpecType",
|
|
13910
14610
|
"required_fields": [
|
|
@@ -13960,6 +14660,7 @@
|
|
|
13960
14660
|
}
|
|
13961
14661
|
}
|
|
13962
14662
|
},
|
|
14663
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
13963
14664
|
"x-f5xc-minimum-configuration": {
|
|
13964
14665
|
"description": "Minimum configuration for secret_management_accessStatusObject",
|
|
13965
14666
|
"required_fields": [
|
|
@@ -13988,6 +14689,8 @@
|
|
|
13988
14689
|
"x-displayname": "Kind",
|
|
13989
14690
|
"x-ves-example": "Virtual_site.",
|
|
13990
14691
|
"x-f5xc-example": "virtual_site",
|
|
14692
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")",
|
|
14693
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").",
|
|
13991
14694
|
"minLength": 0,
|
|
13992
14695
|
"maxLength": 14,
|
|
13993
14696
|
"x-f5xc-required-for": {
|
|
@@ -13999,7 +14702,7 @@
|
|
|
13999
14702
|
"readOnly": true,
|
|
14000
14703
|
"x-original-maxLength": 1024,
|
|
14001
14704
|
"x-reconciled-from-discovery": true,
|
|
14002
|
-
"x-reconciled-at": "2026-01-
|
|
14705
|
+
"x-reconciled-at": "2026-01-07T15:29:16.469699+00:00"
|
|
14003
14706
|
},
|
|
14004
14707
|
"name": {
|
|
14005
14708
|
"type": "string",
|
|
@@ -14008,6 +14711,8 @@
|
|
|
14008
14711
|
"x-displayname": "Name",
|
|
14009
14712
|
"x-ves-example": "Contactus-route.",
|
|
14010
14713
|
"x-f5xc-example": "contactus-route",
|
|
14714
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
|
|
14715
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
|
|
14011
14716
|
"minLength": 0,
|
|
14012
14717
|
"maxLength": 16,
|
|
14013
14718
|
"x-f5xc-required-for": {
|
|
@@ -14018,7 +14723,7 @@
|
|
|
14018
14723
|
},
|
|
14019
14724
|
"x-original-maxLength": 1024,
|
|
14020
14725
|
"x-reconciled-from-discovery": true,
|
|
14021
|
-
"x-reconciled-at": "2026-01-
|
|
14726
|
+
"x-reconciled-at": "2026-01-07T15:29:16.469707+00:00"
|
|
14022
14727
|
},
|
|
14023
14728
|
"namespace": {
|
|
14024
14729
|
"type": "string",
|
|
@@ -14027,6 +14732,8 @@
|
|
|
14027
14732
|
"x-displayname": "Namespace",
|
|
14028
14733
|
"x-ves-example": "Ns1",
|
|
14029
14734
|
"x-f5xc-example": "ns1",
|
|
14735
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
|
|
14736
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
|
|
14030
14737
|
"minLength": 0,
|
|
14031
14738
|
"maxLength": 6,
|
|
14032
14739
|
"x-f5xc-required-for": {
|
|
@@ -14037,7 +14744,7 @@
|
|
|
14037
14744
|
},
|
|
14038
14745
|
"x-original-maxLength": 1024,
|
|
14039
14746
|
"x-reconciled-from-discovery": true,
|
|
14040
|
-
"x-reconciled-at": "2026-01-
|
|
14747
|
+
"x-reconciled-at": "2026-01-07T15:29:16.469711+00:00"
|
|
14041
14748
|
},
|
|
14042
14749
|
"tenant": {
|
|
14043
14750
|
"type": "string",
|
|
@@ -14046,6 +14753,8 @@
|
|
|
14046
14753
|
"x-displayname": "Tenant",
|
|
14047
14754
|
"x-ves-example": "Example-corp.",
|
|
14048
14755
|
"x-f5xc-example": "example-corp",
|
|
14756
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.",
|
|
14757
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.",
|
|
14049
14758
|
"minLength": 0,
|
|
14050
14759
|
"maxLength": 18,
|
|
14051
14760
|
"x-f5xc-required-for": {
|
|
@@ -14058,7 +14767,7 @@
|
|
|
14058
14767
|
"x-field-mutability": "read-only",
|
|
14059
14768
|
"x-original-maxLength": 1024,
|
|
14060
14769
|
"x-reconciled-from-discovery": true,
|
|
14061
|
-
"x-reconciled-at": "2026-01-
|
|
14770
|
+
"x-reconciled-at": "2026-01-07T15:29:16.469716+00:00"
|
|
14062
14771
|
},
|
|
14063
14772
|
"uid": {
|
|
14064
14773
|
"type": "string",
|
|
@@ -14067,6 +14776,8 @@
|
|
|
14067
14776
|
"x-displayname": "UID",
|
|
14068
14777
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
14069
14778
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
14779
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.",
|
|
14780
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.",
|
|
14070
14781
|
"minLength": 0,
|
|
14071
14782
|
"maxLength": 36,
|
|
14072
14783
|
"x-f5xc-required-for": {
|
|
@@ -14080,9 +14791,11 @@
|
|
|
14080
14791
|
"x-original-maxLength": 1024,
|
|
14081
14792
|
"format": "uuid",
|
|
14082
14793
|
"x-reconciled-from-discovery": true,
|
|
14083
|
-
"x-reconciled-at": "2026-01-
|
|
14794
|
+
"x-reconciled-at": "2026-01-07T15:29:16.469722+00:00"
|
|
14084
14795
|
}
|
|
14085
14796
|
},
|
|
14797
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
14798
|
+
"x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...",
|
|
14086
14799
|
"x-f5xc-minimum-configuration": {
|
|
14087
14800
|
"description": "Minimum configuration for ioschemaObjectRefType",
|
|
14088
14801
|
"required_fields": [
|
|
@@ -14129,7 +14842,7 @@
|
|
|
14129
14842
|
},
|
|
14130
14843
|
"x-original-maxLength": 256,
|
|
14131
14844
|
"x-reconciled-from-discovery": true,
|
|
14132
|
-
"x-reconciled-at": "2026-01-
|
|
14845
|
+
"x-reconciled-at": "2026-01-07T15:29:16.469773+00:00"
|
|
14133
14846
|
},
|
|
14134
14847
|
"name": {
|
|
14135
14848
|
"type": "string",
|
|
@@ -14150,6 +14863,7 @@
|
|
|
14150
14863
|
"ves.io.schema.rules.string.min_len": "1",
|
|
14151
14864
|
"ves.io.schema.rules.string.ves_object_name": "true"
|
|
14152
14865
|
},
|
|
14866
|
+
"x-f5xc-description-short": "Name of the message. The value of name has to follow DNS-1035 format.",
|
|
14153
14867
|
"maxLength": 16,
|
|
14154
14868
|
"x-f5xc-required-for": {
|
|
14155
14869
|
"minimum_config": false,
|
|
@@ -14159,9 +14873,11 @@
|
|
|
14159
14873
|
},
|
|
14160
14874
|
"x-original-maxLength": 1024,
|
|
14161
14875
|
"x-reconciled-from-discovery": true,
|
|
14162
|
-
"x-reconciled-at": "2026-01-
|
|
14876
|
+
"x-reconciled-at": "2026-01-07T15:29:16.469778+00:00"
|
|
14163
14877
|
}
|
|
14164
14878
|
},
|
|
14879
|
+
"x-f5xc-description-short": "MessageMetaType is metadata (common attributes) of a message that only certain messages have.",
|
|
14880
|
+
"x-f5xc-description-medium": "MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create...",
|
|
14165
14881
|
"x-f5xc-minimum-configuration": {
|
|
14166
14882
|
"description": "Minimum configuration for schemaMessageMetaType",
|
|
14167
14883
|
"required_fields": [
|
|
@@ -14190,6 +14906,8 @@
|
|
|
14190
14906
|
"x-displayname": "Allow F5XC.",
|
|
14191
14907
|
"x-ves-example": "True",
|
|
14192
14908
|
"x-f5xc-example": "true",
|
|
14909
|
+
"x-f5xc-description-short": "If allow_f5xc is set to true, it allows relevant F5XC infrastructure services to decrypt the secret encrypted using this policy.",
|
|
14910
|
+
"x-f5xc-description-medium": "If allow_f5xc is set to true, it allows relevant F5XC infrastructure services to decrypt the secret encrypted using this policy.",
|
|
14193
14911
|
"x-f5xc-required-for": {
|
|
14194
14912
|
"minimum_config": false,
|
|
14195
14913
|
"create": false,
|
|
@@ -14203,6 +14921,8 @@
|
|
|
14203
14921
|
"x-displayname": "Decrypt Cache Timeout.",
|
|
14204
14922
|
"x-ves-example": "6h",
|
|
14205
14923
|
"x-f5xc-example": "6h",
|
|
14924
|
+
"x-f5xc-description-short": "Decrypt_cache_timeout contains the amount of time a decrypted secret is cached in wingman.",
|
|
14925
|
+
"x-f5xc-description-medium": "Decrypt_cache_timeout contains the amount of time a decrypted secret is cached in wingman. Value for this parameter is a string ending in the suffix \"s\" (indicating seconds), suffix \"m\" (indicating minutes) or suffix \"h\" (indicating hours).",
|
|
14206
14926
|
"minLength": 0,
|
|
14207
14927
|
"maxLength": 1024,
|
|
14208
14928
|
"x-f5xc-required-for": {
|
|
@@ -14216,6 +14936,7 @@
|
|
|
14216
14936
|
"$ref": "#/components/schemas/secret_policyRuleList"
|
|
14217
14937
|
}
|
|
14218
14938
|
},
|
|
14939
|
+
"x-f5xc-description-short": "Create secret_policy creates a new object in the storage backend for metadata.namespace.",
|
|
14219
14940
|
"x-f5xc-minimum-configuration": {
|
|
14220
14941
|
"description": "Minimum configuration for schemasecret_policyCreateSpecType",
|
|
14221
14942
|
"required_fields": [
|
|
@@ -14245,6 +14966,8 @@
|
|
|
14245
14966
|
"x-displayname": "Allow F5XC.",
|
|
14246
14967
|
"x-ves-example": "True",
|
|
14247
14968
|
"x-f5xc-example": "true",
|
|
14969
|
+
"x-f5xc-description-short": "If allow_f5xc is set to true, it allows relevant F5XC infrastructure services to decrypt the secret encrypted using this policy.",
|
|
14970
|
+
"x-f5xc-description-medium": "If allow_f5xc is set to true, it allows relevant F5XC infrastructure services to decrypt the secret encrypted using this policy.",
|
|
14248
14971
|
"x-f5xc-required-for": {
|
|
14249
14972
|
"minimum_config": false,
|
|
14250
14973
|
"create": false,
|
|
@@ -14258,6 +14981,8 @@
|
|
|
14258
14981
|
"x-displayname": "Decrypt Cache Timeout.",
|
|
14259
14982
|
"x-ves-example": "6h",
|
|
14260
14983
|
"x-f5xc-example": "6h",
|
|
14984
|
+
"x-f5xc-description-short": "Decrypt_cache_timeout contains the amount of time a decrypted secret is cached in wingman.",
|
|
14985
|
+
"x-f5xc-description-medium": "Decrypt_cache_timeout contains the amount of time a decrypted secret is cached in wingman. Value for this parameter is a string ending in the suffix \"s\" (indicating seconds), suffix \"m\" (indicating minutes) or suffix \"h\" (indicating hours).",
|
|
14261
14986
|
"minLength": 0,
|
|
14262
14987
|
"maxLength": 1024,
|
|
14263
14988
|
"x-f5xc-required-for": {
|
|
@@ -14273,6 +14998,8 @@
|
|
|
14273
14998
|
"title": "Deletion Time.",
|
|
14274
14999
|
"format": "date-time",
|
|
14275
15000
|
"x-displayname": "Deletion Time.",
|
|
15001
|
+
"x-f5xc-description-short": "Deletion_time is set when the secret policy object is marked for DELETE, secret policy marked for DELETE will be automatically deleted after...",
|
|
15002
|
+
"x-f5xc-description-medium": "Deletion_time is set when the secret policy object is marked for DELETE, secret policy marked for DELETE will be automatically deleted after deletion_time.",
|
|
14276
15003
|
"minLength": 0,
|
|
14277
15004
|
"maxLength": 1024,
|
|
14278
15005
|
"x-f5xc-required-for": {
|
|
@@ -14291,6 +15018,8 @@
|
|
|
14291
15018
|
"title": "Marked For DELETE.",
|
|
14292
15019
|
"format": "boolean",
|
|
14293
15020
|
"x-displayname": "Marked For DELETE.",
|
|
15021
|
+
"x-f5xc-description-short": "Marked_for_delete is set when the secret policy object is marked for DELETE, based on this value secret policy marked for DELETE will be...",
|
|
15022
|
+
"x-f5xc-description-medium": "Marked_for_delete is set when the secret policy object is marked for DELETE, based on this value secret policy marked for DELETE will be automatically deleted after deletion_time.",
|
|
14294
15023
|
"x-f5xc-required-for": {
|
|
14295
15024
|
"minimum_config": false,
|
|
14296
15025
|
"create": false,
|
|
@@ -14302,6 +15031,7 @@
|
|
|
14302
15031
|
"$ref": "#/components/schemas/secret_policyRuleList"
|
|
14303
15032
|
}
|
|
14304
15033
|
},
|
|
15034
|
+
"x-f5xc-description-short": "GET secret_policy reads a given object from storage backend for metadata.namespace.",
|
|
14305
15035
|
"x-f5xc-minimum-configuration": {
|
|
14306
15036
|
"description": "Minimum configuration for schemasecret_policyGetSpecType",
|
|
14307
15037
|
"required_fields": [
|
|
@@ -14334,6 +15064,8 @@
|
|
|
14334
15064
|
"x-displayname": "Allow F5XC.",
|
|
14335
15065
|
"x-ves-example": "True",
|
|
14336
15066
|
"x-f5xc-example": "true",
|
|
15067
|
+
"x-f5xc-description-short": "If allow_f5xc is set to true, it allows relevant F5XC infrastructure services to decrypt the secret encrypted using this policy.",
|
|
15068
|
+
"x-f5xc-description-medium": "If allow_f5xc is set to true, it allows relevant F5XC infrastructure services to decrypt the secret encrypted using this policy.",
|
|
14337
15069
|
"x-f5xc-required-for": {
|
|
14338
15070
|
"minimum_config": false,
|
|
14339
15071
|
"create": false,
|
|
@@ -14347,6 +15079,8 @@
|
|
|
14347
15079
|
"x-displayname": "Decrypt Cache Timeout.",
|
|
14348
15080
|
"x-ves-example": "6h",
|
|
14349
15081
|
"x-f5xc-example": "6h",
|
|
15082
|
+
"x-f5xc-description-short": "Decrypt_cache_timeout contains the amount of time a decrypted secret is cached in wingman.",
|
|
15083
|
+
"x-f5xc-description-medium": "Decrypt_cache_timeout contains the amount of time a decrypted secret is cached in wingman. Value for this parameter is a string ending in the suffix \"s\" (indicating seconds), suffix \"m\" (indicating minutes) or suffix \"h\" (indicating hours).",
|
|
14350
15084
|
"minLength": 0,
|
|
14351
15085
|
"maxLength": 1024,
|
|
14352
15086
|
"x-f5xc-required-for": {
|
|
@@ -14363,6 +15097,7 @@
|
|
|
14363
15097
|
"$ref": "#/components/schemas/secret_policyRuleList"
|
|
14364
15098
|
}
|
|
14365
15099
|
},
|
|
15100
|
+
"x-f5xc-description-short": "Replace secret_policy replaces an existing object in the storage backend for metadata.namespace.",
|
|
14366
15101
|
"x-f5xc-minimum-configuration": {
|
|
14367
15102
|
"description": "Minimum configuration for schemasecret_policyReplaceSpecType",
|
|
14368
15103
|
"required_fields": [
|
|
@@ -14446,6 +15181,7 @@
|
|
|
14446
15181
|
"title": "Fail_if_referred.",
|
|
14447
15182
|
"format": "boolean",
|
|
14448
15183
|
"x-displayname": "Fail-If-Referred.",
|
|
15184
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
14449
15185
|
"x-f5xc-required-for": {
|
|
14450
15186
|
"minimum_config": false,
|
|
14451
15187
|
"create": false,
|
|
@@ -14470,7 +15206,7 @@
|
|
|
14470
15206
|
},
|
|
14471
15207
|
"x-original-maxLength": 1024,
|
|
14472
15208
|
"x-reconciled-from-discovery": true,
|
|
14473
|
-
"x-reconciled-at": "2026-01-
|
|
15209
|
+
"x-reconciled-at": "2026-01-07T15:29:16.469933+00:00"
|
|
14474
15210
|
},
|
|
14475
15211
|
"namespace": {
|
|
14476
15212
|
"type": "string",
|
|
@@ -14479,6 +15215,7 @@
|
|
|
14479
15215
|
"x-displayname": "Namespace",
|
|
14480
15216
|
"x-ves-example": "Ns1",
|
|
14481
15217
|
"x-f5xc-example": "ns1",
|
|
15218
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
14482
15219
|
"minLength": 0,
|
|
14483
15220
|
"maxLength": 6,
|
|
14484
15221
|
"x-f5xc-required-for": {
|
|
@@ -14489,7 +15226,7 @@
|
|
|
14489
15226
|
},
|
|
14490
15227
|
"x-original-maxLength": 1024,
|
|
14491
15228
|
"x-reconciled-from-discovery": true,
|
|
14492
|
-
"x-reconciled-at": "2026-01-
|
|
15229
|
+
"x-reconciled-at": "2026-01-07T15:29:16.469938+00:00"
|
|
14493
15230
|
}
|
|
14494
15231
|
},
|
|
14495
15232
|
"x-f5xc-minimum-configuration": {
|
|
@@ -14524,6 +15261,7 @@
|
|
|
14524
15261
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
14525
15262
|
},
|
|
14526
15263
|
"x-displayname": "Deleted Referred Objects.",
|
|
15264
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
14527
15265
|
"x-f5xc-required-for": {
|
|
14528
15266
|
"minimum_config": false,
|
|
14529
15267
|
"create": false,
|
|
@@ -14539,6 +15277,7 @@
|
|
|
14539
15277
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
14540
15278
|
},
|
|
14541
15279
|
"x-displayname": "Disabled Referred Objects.",
|
|
15280
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
14542
15281
|
"x-f5xc-required-for": {
|
|
14543
15282
|
"minimum_config": false,
|
|
14544
15283
|
"create": false,
|
|
@@ -14557,6 +15296,7 @@
|
|
|
14557
15296
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
14558
15297
|
},
|
|
14559
15298
|
"x-displayname": "Referring Objects.",
|
|
15299
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
14560
15300
|
"x-f5xc-required-for": {
|
|
14561
15301
|
"minimum_config": false,
|
|
14562
15302
|
"create": false,
|
|
@@ -14578,6 +15318,8 @@
|
|
|
14578
15318
|
"$ref": "#/components/schemas/secret_policyStatusObject"
|
|
14579
15319
|
},
|
|
14580
15320
|
"x-displayname": "Status",
|
|
15321
|
+
"x-f5xc-example": "active",
|
|
15322
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
14581
15323
|
"x-f5xc-required-for": {
|
|
14582
15324
|
"minimum_config": false,
|
|
14583
15325
|
"create": false,
|
|
@@ -14587,7 +15329,7 @@
|
|
|
14587
15329
|
"maxLength": 17,
|
|
14588
15330
|
"minLength": 17,
|
|
14589
15331
|
"x-reconciled-from-discovery": true,
|
|
14590
|
-
"x-reconciled-at": "2026-01-
|
|
15332
|
+
"x-reconciled-at": "2026-01-07T15:29:16.469952+00:00"
|
|
14591
15333
|
},
|
|
14592
15334
|
"system_metadata": {
|
|
14593
15335
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -14627,6 +15369,8 @@
|
|
|
14627
15369
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
14628
15370
|
],
|
|
14629
15371
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
15372
|
+
"x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
|
|
15373
|
+
"x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
|
|
14630
15374
|
"x-f5xc-minimum-configuration": {
|
|
14631
15375
|
"description": "Minimum configuration for secret_policyGetResponseFormatCode",
|
|
14632
15376
|
"required_fields": [],
|
|
@@ -14659,6 +15403,9 @@
|
|
|
14659
15403
|
"x-validation-rules": {
|
|
14660
15404
|
"ves.io.schema.rules.repeated.max_items": "256"
|
|
14661
15405
|
},
|
|
15406
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
15407
|
+
"x-f5xc-description-short": "List of references to service_policy_rule objects. The order of evaluation of the rules depends on the rule combining algorithm.",
|
|
15408
|
+
"x-f5xc-description-medium": "List of references to service_policy_rule objects. The order of evaluation of the rules depends on the rule combining algorithm.",
|
|
14662
15409
|
"x-f5xc-required-for": {
|
|
14663
15410
|
"minimum_config": false,
|
|
14664
15411
|
"create": false,
|
|
@@ -14667,6 +15414,8 @@
|
|
|
14667
15414
|
}
|
|
14668
15415
|
}
|
|
14669
15416
|
},
|
|
15417
|
+
"x-f5xc-description-short": "List of references to service_policy_rule objects. The order of evaluation of the rules depends on the rule combining algorithm.",
|
|
15418
|
+
"x-f5xc-description-medium": "List of references to service_policy_rule objects. The order of evaluation of the rules depends on the rule combining algorithm.",
|
|
14670
15419
|
"x-f5xc-minimum-configuration": {
|
|
14671
15420
|
"description": "Minimum configuration for secret_policyLegacyRuleList",
|
|
14672
15421
|
"required_fields": [
|
|
@@ -14694,6 +15443,7 @@
|
|
|
14694
15443
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
14695
15444
|
},
|
|
14696
15445
|
"x-displayname": "Errors",
|
|
15446
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
14697
15447
|
"x-f5xc-required-for": {
|
|
14698
15448
|
"minimum_config": false,
|
|
14699
15449
|
"create": false,
|
|
@@ -14709,6 +15459,8 @@
|
|
|
14709
15459
|
"$ref": "#/components/schemas/secret_policyListPolicyResponseItem"
|
|
14710
15460
|
},
|
|
14711
15461
|
"x-displayname": "Items",
|
|
15462
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
15463
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
14712
15464
|
"x-f5xc-required-for": {
|
|
14713
15465
|
"minimum_config": false,
|
|
14714
15466
|
"create": false,
|
|
@@ -14717,6 +15469,7 @@
|
|
|
14717
15469
|
}
|
|
14718
15470
|
}
|
|
14719
15471
|
},
|
|
15472
|
+
"x-f5xc-description-short": "Response message of the 'ListPolicy' RPC.",
|
|
14720
15473
|
"x-f5xc-minimum-configuration": {
|
|
14721
15474
|
"description": "Minimum configuration for secret_policyListPolicyResponse",
|
|
14722
15475
|
"required_fields": [
|
|
@@ -14741,6 +15494,8 @@
|
|
|
14741
15494
|
"description": "The set of annotations present on this secret_policy.",
|
|
14742
15495
|
"title": "Annotations.",
|
|
14743
15496
|
"x-displayname": "Annotations.",
|
|
15497
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
15498
|
+
"x-f5xc-description-short": "The set of annotations present on this secret_policy.",
|
|
14744
15499
|
"x-f5xc-required-for": {
|
|
14745
15500
|
"minimum_config": false,
|
|
14746
15501
|
"create": false,
|
|
@@ -14753,6 +15508,7 @@
|
|
|
14753
15508
|
"description": "The description set for this secret_policy.",
|
|
14754
15509
|
"title": "Description.",
|
|
14755
15510
|
"x-displayname": "Description.",
|
|
15511
|
+
"x-f5xc-description-short": "The description set for this secret_policy.",
|
|
14756
15512
|
"minLength": 0,
|
|
14757
15513
|
"maxLength": 0,
|
|
14758
15514
|
"x-f5xc-required-for": {
|
|
@@ -14763,7 +15519,7 @@
|
|
|
14763
15519
|
},
|
|
14764
15520
|
"x-original-maxLength": 1024,
|
|
14765
15521
|
"x-reconciled-from-discovery": true,
|
|
14766
|
-
"x-reconciled-at": "2026-01-
|
|
15522
|
+
"x-reconciled-at": "2026-01-07T15:29:16.469966+00:00"
|
|
14767
15523
|
},
|
|
14768
15524
|
"disabled": {
|
|
14769
15525
|
"type": "boolean",
|
|
@@ -14771,6 +15527,8 @@
|
|
|
14771
15527
|
"title": "Disabled",
|
|
14772
15528
|
"format": "boolean",
|
|
14773
15529
|
"x-displayname": "Disabled",
|
|
15530
|
+
"x-f5xc-example": "True",
|
|
15531
|
+
"x-f5xc-description-short": "Value of true indicates secret_policy is administratively disabled.",
|
|
14774
15532
|
"x-f5xc-required-for": {
|
|
14775
15533
|
"minimum_config": false,
|
|
14776
15534
|
"create": false,
|
|
@@ -14786,6 +15544,8 @@
|
|
|
14786
15544
|
"description": "The set of labels present on this secret_policy.",
|
|
14787
15545
|
"title": "Labels",
|
|
14788
15546
|
"x-displayname": "Labels",
|
|
15547
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
15548
|
+
"x-f5xc-description-short": "The set of labels present on this secret_policy.",
|
|
14789
15549
|
"x-f5xc-required-for": {
|
|
14790
15550
|
"minimum_config": false,
|
|
14791
15551
|
"create": false,
|
|
@@ -14813,7 +15573,7 @@
|
|
|
14813
15573
|
},
|
|
14814
15574
|
"x-original-maxLength": 1024,
|
|
14815
15575
|
"x-reconciled-from-discovery": true,
|
|
14816
|
-
"x-reconciled-at": "2026-01-
|
|
15576
|
+
"x-reconciled-at": "2026-01-07T15:29:16.469976+00:00"
|
|
14817
15577
|
},
|
|
14818
15578
|
"namespace": {
|
|
14819
15579
|
"type": "string",
|
|
@@ -14832,7 +15592,7 @@
|
|
|
14832
15592
|
},
|
|
14833
15593
|
"x-original-maxLength": 1024,
|
|
14834
15594
|
"x-reconciled-from-discovery": true,
|
|
14835
|
-
"x-reconciled-at": "2026-01-
|
|
15595
|
+
"x-reconciled-at": "2026-01-07T15:29:16.469980+00:00"
|
|
14836
15596
|
},
|
|
14837
15597
|
"system_metadata": {
|
|
14838
15598
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -14855,7 +15615,7 @@
|
|
|
14855
15615
|
"x-field-mutability": "read-only",
|
|
14856
15616
|
"x-original-maxLength": 1024,
|
|
14857
15617
|
"x-reconciled-from-discovery": true,
|
|
14858
|
-
"x-reconciled-at": "2026-01-
|
|
15618
|
+
"x-reconciled-at": "2026-01-07T15:29:16.469985+00:00"
|
|
14859
15619
|
},
|
|
14860
15620
|
"uid": {
|
|
14861
15621
|
"type": "string",
|
|
@@ -14876,7 +15636,7 @@
|
|
|
14876
15636
|
"x-original-maxLength": 1024,
|
|
14877
15637
|
"format": "uuid",
|
|
14878
15638
|
"x-reconciled-from-discovery": true,
|
|
14879
|
-
"x-reconciled-at": "2026-01-
|
|
15639
|
+
"x-reconciled-at": "2026-01-07T15:29:16.469990+00:00"
|
|
14880
15640
|
}
|
|
14881
15641
|
},
|
|
14882
15642
|
"x-f5xc-minimum-configuration": {
|
|
@@ -14916,6 +15676,7 @@
|
|
|
14916
15676
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
14917
15677
|
},
|
|
14918
15678
|
"x-displayname": "Errors",
|
|
15679
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
14919
15680
|
"x-f5xc-required-for": {
|
|
14920
15681
|
"minimum_config": false,
|
|
14921
15682
|
"create": false,
|
|
@@ -14931,6 +15692,8 @@
|
|
|
14931
15692
|
"$ref": "#/components/schemas/secret_policyListResponseItem"
|
|
14932
15693
|
},
|
|
14933
15694
|
"x-displayname": "Items",
|
|
15695
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
15696
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
14934
15697
|
"x-f5xc-required-for": {
|
|
14935
15698
|
"minimum_config": false,
|
|
14936
15699
|
"create": false,
|
|
@@ -14964,6 +15727,8 @@
|
|
|
14964
15727
|
"description": "The set of annotations present on this secret_policy.",
|
|
14965
15728
|
"title": "Annotations.",
|
|
14966
15729
|
"x-displayname": "Annotations.",
|
|
15730
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
15731
|
+
"x-f5xc-description-short": "The set of annotations present on this secret_policy.",
|
|
14967
15732
|
"x-f5xc-required-for": {
|
|
14968
15733
|
"minimum_config": false,
|
|
14969
15734
|
"create": false,
|
|
@@ -14976,6 +15741,7 @@
|
|
|
14976
15741
|
"description": "The description set for this secret_policy.",
|
|
14977
15742
|
"title": "Description.",
|
|
14978
15743
|
"x-displayname": "Description.",
|
|
15744
|
+
"x-f5xc-description-short": "The description set for this secret_policy.",
|
|
14979
15745
|
"minLength": 0,
|
|
14980
15746
|
"maxLength": 0,
|
|
14981
15747
|
"x-f5xc-required-for": {
|
|
@@ -14986,7 +15752,7 @@
|
|
|
14986
15752
|
},
|
|
14987
15753
|
"x-original-maxLength": 1024,
|
|
14988
15754
|
"x-reconciled-from-discovery": true,
|
|
14989
|
-
"x-reconciled-at": "2026-01-
|
|
15755
|
+
"x-reconciled-at": "2026-01-07T15:29:16.469999+00:00"
|
|
14990
15756
|
},
|
|
14991
15757
|
"disabled": {
|
|
14992
15758
|
"type": "boolean",
|
|
@@ -14994,6 +15760,8 @@
|
|
|
14994
15760
|
"title": "Disabled",
|
|
14995
15761
|
"format": "boolean",
|
|
14996
15762
|
"x-displayname": "Disabled",
|
|
15763
|
+
"x-f5xc-example": "True",
|
|
15764
|
+
"x-f5xc-description-short": "Value of true indicates secret_policy is administratively disabled.",
|
|
14997
15765
|
"x-f5xc-required-for": {
|
|
14998
15766
|
"minimum_config": false,
|
|
14999
15767
|
"create": false,
|
|
@@ -15009,6 +15777,8 @@
|
|
|
15009
15777
|
"description": "The set of labels present on this secret_policy.",
|
|
15010
15778
|
"title": "Labels",
|
|
15011
15779
|
"x-displayname": "Labels",
|
|
15780
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
15781
|
+
"x-f5xc-description-short": "The set of labels present on this secret_policy.",
|
|
15012
15782
|
"x-f5xc-required-for": {
|
|
15013
15783
|
"minimum_config": false,
|
|
15014
15784
|
"create": false,
|
|
@@ -15036,7 +15806,7 @@
|
|
|
15036
15806
|
},
|
|
15037
15807
|
"x-original-maxLength": 1024,
|
|
15038
15808
|
"x-reconciled-from-discovery": true,
|
|
15039
|
-
"x-reconciled-at": "2026-01-
|
|
15809
|
+
"x-reconciled-at": "2026-01-07T15:29:16.470009+00:00"
|
|
15040
15810
|
},
|
|
15041
15811
|
"namespace": {
|
|
15042
15812
|
"type": "string",
|
|
@@ -15055,7 +15825,7 @@
|
|
|
15055
15825
|
},
|
|
15056
15826
|
"x-original-maxLength": 1024,
|
|
15057
15827
|
"x-reconciled-from-discovery": true,
|
|
15058
|
-
"x-reconciled-at": "2026-01-
|
|
15828
|
+
"x-reconciled-at": "2026-01-07T15:29:16.470013+00:00"
|
|
15059
15829
|
},
|
|
15060
15830
|
"owner_view": {
|
|
15061
15831
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -15068,6 +15838,7 @@
|
|
|
15068
15838
|
"$ref": "#/components/schemas/secret_policyStatusObject"
|
|
15069
15839
|
},
|
|
15070
15840
|
"x-displayname": "Status",
|
|
15841
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
15071
15842
|
"x-f5xc-required-for": {
|
|
15072
15843
|
"minimum_config": false,
|
|
15073
15844
|
"create": false,
|
|
@@ -15096,7 +15867,7 @@
|
|
|
15096
15867
|
"x-field-mutability": "read-only",
|
|
15097
15868
|
"x-original-maxLength": 1024,
|
|
15098
15869
|
"x-reconciled-from-discovery": true,
|
|
15099
|
-
"x-reconciled-at": "2026-01-
|
|
15870
|
+
"x-reconciled-at": "2026-01-07T15:29:16.470020+00:00"
|
|
15100
15871
|
},
|
|
15101
15872
|
"uid": {
|
|
15102
15873
|
"type": "string",
|
|
@@ -15117,9 +15888,11 @@
|
|
|
15117
15888
|
"x-original-maxLength": 1024,
|
|
15118
15889
|
"format": "uuid",
|
|
15119
15890
|
"x-reconciled-from-discovery": true,
|
|
15120
|
-
"x-reconciled-at": "2026-01-
|
|
15891
|
+
"x-reconciled-at": "2026-01-07T15:29:16.470025+00:00"
|
|
15121
15892
|
}
|
|
15122
15893
|
},
|
|
15894
|
+
"x-f5xc-description-short": "By default a summary of secret_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
15895
|
+
"x-f5xc-description-medium": "By default a summary of secret_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
15123
15896
|
"x-f5xc-minimum-configuration": {
|
|
15124
15897
|
"description": "Minimum configuration for secret_policyListResponseItem",
|
|
15125
15898
|
"required_fields": [
|
|
@@ -15165,6 +15938,7 @@
|
|
|
15165
15938
|
"x-validation-rules": {
|
|
15166
15939
|
"ves.io.schema.rules.message.required": "true"
|
|
15167
15940
|
},
|
|
15941
|
+
"x-f5xc-description-short": "Name of the secret policy Required: YES.",
|
|
15168
15942
|
"minLength": 0,
|
|
15169
15943
|
"maxLength": 16,
|
|
15170
15944
|
"x-f5xc-required-for": {
|
|
@@ -15175,7 +15949,7 @@
|
|
|
15175
15949
|
},
|
|
15176
15950
|
"x-original-maxLength": 1024,
|
|
15177
15951
|
"x-reconciled-from-discovery": true,
|
|
15178
|
-
"x-reconciled-at": "2026-01-
|
|
15952
|
+
"x-reconciled-at": "2026-01-07T15:29:16.470030+00:00"
|
|
15179
15953
|
},
|
|
15180
15954
|
"namespace": {
|
|
15181
15955
|
"type": "string",
|
|
@@ -15191,6 +15965,7 @@
|
|
|
15191
15965
|
"x-validation-rules": {
|
|
15192
15966
|
"ves.io.schema.rules.message.required": "true"
|
|
15193
15967
|
},
|
|
15968
|
+
"x-f5xc-description-short": "Namespace of the secret policy Required: YES.",
|
|
15194
15969
|
"minLength": 0,
|
|
15195
15970
|
"maxLength": 6,
|
|
15196
15971
|
"x-f5xc-required-for": {
|
|
@@ -15201,9 +15976,10 @@
|
|
|
15201
15976
|
},
|
|
15202
15977
|
"x-original-maxLength": 1024,
|
|
15203
15978
|
"x-reconciled-from-discovery": true,
|
|
15204
|
-
"x-reconciled-at": "2026-01-
|
|
15979
|
+
"x-reconciled-at": "2026-01-07T15:29:16.470034+00:00"
|
|
15205
15980
|
}
|
|
15206
15981
|
},
|
|
15982
|
+
"x-f5xc-description-short": "Input message of the 'RecoverPolicy' RPC.",
|
|
15207
15983
|
"x-f5xc-minimum-configuration": {
|
|
15208
15984
|
"description": "Minimum configuration for secret_policyRecoverRequest",
|
|
15209
15985
|
"required_fields": [
|
|
@@ -15241,9 +16017,10 @@
|
|
|
15241
16017
|
},
|
|
15242
16018
|
"x-original-maxLength": 1024,
|
|
15243
16019
|
"x-reconciled-from-discovery": true,
|
|
15244
|
-
"x-reconciled-at": "2026-01-
|
|
16020
|
+
"x-reconciled-at": "2026-01-07T15:29:16.470038+00:00"
|
|
15245
16021
|
}
|
|
15246
16022
|
},
|
|
16023
|
+
"x-f5xc-description-short": "Response message of the 'RecoverPolicy' RPC.",
|
|
15247
16024
|
"x-f5xc-minimum-configuration": {
|
|
15248
16025
|
"description": "Minimum configuration for secret_policyRecoverResponse",
|
|
15249
16026
|
"required_fields": [
|
|
@@ -15310,6 +16087,8 @@
|
|
|
15310
16087
|
"$ref": "#/components/schemas/schemasecret_policy_ruleGlobalSpecType"
|
|
15311
16088
|
}
|
|
15312
16089
|
},
|
|
16090
|
+
"x-f5xc-description-short": "Rule consists of an unordered list of predicates and an action.",
|
|
16091
|
+
"x-f5xc-description-medium": "Rule consists of an unordered list of predicates and an action. The predicates are evaluated against a set of input fields that are extracted from or derived from an L7 request API. A request API is considered to match the simple rule if all predicates in the rule evaluate to true for that request.",
|
|
15313
16092
|
"x-f5xc-minimum-configuration": {
|
|
15314
16093
|
"description": "Minimum configuration for secret_policyRule",
|
|
15315
16094
|
"required_fields": [
|
|
@@ -15347,6 +16126,9 @@
|
|
|
15347
16126
|
"ves.io.schema.rules.repeated.max_items": "256",
|
|
15348
16127
|
"ves.io.schema.rules.repeated.unique_metadata_name": "true"
|
|
15349
16128
|
},
|
|
16129
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
16130
|
+
"x-f5xc-description-short": "Define the list of rules (with an order) that should be evaluated by this service policy.",
|
|
16131
|
+
"x-f5xc-description-medium": "Define the list of rules (with an order) that should be evaluated by this service policy. Rules are evaluated from top to bottom in the list.",
|
|
15350
16132
|
"x-f5xc-required-for": {
|
|
15351
16133
|
"minimum_config": false,
|
|
15352
16134
|
"create": false,
|
|
@@ -15355,6 +16137,7 @@
|
|
|
15355
16137
|
}
|
|
15356
16138
|
}
|
|
15357
16139
|
},
|
|
16140
|
+
"x-f5xc-description-short": "List of rules. The order of evaluation of the rules depends on the rule combining algorithm.",
|
|
15358
16141
|
"x-f5xc-minimum-configuration": {
|
|
15359
16142
|
"description": "Minimum configuration for secret_policyRuleList",
|
|
15360
16143
|
"required_fields": [
|
|
@@ -15388,6 +16171,7 @@
|
|
|
15388
16171
|
"x-validation-rules": {
|
|
15389
16172
|
"ves.io.schema.rules.message.required": "true"
|
|
15390
16173
|
},
|
|
16174
|
+
"x-f5xc-description-short": "Name of the secret policy Required: YES.",
|
|
15391
16175
|
"minLength": 0,
|
|
15392
16176
|
"maxLength": 16,
|
|
15393
16177
|
"x-f5xc-required-for": {
|
|
@@ -15398,7 +16182,7 @@
|
|
|
15398
16182
|
},
|
|
15399
16183
|
"x-original-maxLength": 1024,
|
|
15400
16184
|
"x-reconciled-from-discovery": true,
|
|
15401
|
-
"x-reconciled-at": "2026-01-
|
|
16185
|
+
"x-reconciled-at": "2026-01-07T15:29:16.470050+00:00"
|
|
15402
16186
|
},
|
|
15403
16187
|
"namespace": {
|
|
15404
16188
|
"type": "string",
|
|
@@ -15414,6 +16198,7 @@
|
|
|
15414
16198
|
"x-validation-rules": {
|
|
15415
16199
|
"ves.io.schema.rules.message.required": "true"
|
|
15416
16200
|
},
|
|
16201
|
+
"x-f5xc-description-short": "Namespace of the secret policy Required: YES.",
|
|
15417
16202
|
"minLength": 0,
|
|
15418
16203
|
"maxLength": 6,
|
|
15419
16204
|
"x-f5xc-required-for": {
|
|
@@ -15424,9 +16209,10 @@
|
|
|
15424
16209
|
},
|
|
15425
16210
|
"x-original-maxLength": 1024,
|
|
15426
16211
|
"x-reconciled-from-discovery": true,
|
|
15427
|
-
"x-reconciled-at": "2026-01-
|
|
16212
|
+
"x-reconciled-at": "2026-01-07T15:29:16.470055+00:00"
|
|
15428
16213
|
}
|
|
15429
16214
|
},
|
|
16215
|
+
"x-f5xc-description-short": "Input message of the 'DeletePolicy' RPC.",
|
|
15430
16216
|
"x-f5xc-minimum-configuration": {
|
|
15431
16217
|
"description": "Minimum configuration for secret_policySoftDeleteRequest",
|
|
15432
16218
|
"required_fields": [
|
|
@@ -15464,9 +16250,10 @@
|
|
|
15464
16250
|
},
|
|
15465
16251
|
"x-original-maxLength": 1024,
|
|
15466
16252
|
"x-reconciled-from-discovery": true,
|
|
15467
|
-
"x-reconciled-at": "2026-01-
|
|
16253
|
+
"x-reconciled-at": "2026-01-07T15:29:16.470059+00:00"
|
|
15468
16254
|
}
|
|
15469
16255
|
},
|
|
16256
|
+
"x-f5xc-description-short": "Response message of the 'DeletePolicy' RPC.",
|
|
15470
16257
|
"x-f5xc-minimum-configuration": {
|
|
15471
16258
|
"description": "Minimum configuration for secret_policySoftDeleteResponse",
|
|
15472
16259
|
"required_fields": [
|
|
@@ -15520,6 +16307,7 @@
|
|
|
15520
16307
|
}
|
|
15521
16308
|
}
|
|
15522
16309
|
},
|
|
16310
|
+
"x-f5xc-description-short": "Most recently observed status of the object.",
|
|
15523
16311
|
"x-f5xc-minimum-configuration": {
|
|
15524
16312
|
"description": "Minimum configuration for secret_policyStatusObject",
|
|
15525
16313
|
"required_fields": [
|
|
@@ -15565,6 +16353,7 @@
|
|
|
15565
16353
|
"ves.io.schema.rules.repeated.max_items": "64",
|
|
15566
16354
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
15567
16355
|
},
|
|
16356
|
+
"x-f5xc-description-short": "List of exact values to match the input against.",
|
|
15568
16357
|
"x-f5xc-required-for": {
|
|
15569
16358
|
"minimum_config": false,
|
|
15570
16359
|
"create": false,
|
|
@@ -15598,6 +16387,7 @@
|
|
|
15598
16387
|
"ves.io.schema.rules.repeated.max_items": "16",
|
|
15599
16388
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
15600
16389
|
},
|
|
16390
|
+
"x-f5xc-description-short": "List of regular expressions to match the input against.",
|
|
15601
16391
|
"x-f5xc-required-for": {
|
|
15602
16392
|
"minimum_config": false,
|
|
15603
16393
|
"create": false,
|
|
@@ -15606,6 +16396,8 @@
|
|
|
15606
16396
|
}
|
|
15607
16397
|
}
|
|
15608
16398
|
},
|
|
16399
|
+
"x-f5xc-description-short": "Matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied.",
|
|
16400
|
+
"x-f5xc-description-medium": "Matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set of supported match criteria includes a list of exact values and a list of regular expressions.",
|
|
15609
16401
|
"x-f5xc-minimum-configuration": {
|
|
15610
16402
|
"description": "Minimum configuration for policyMatcherTypeBasic",
|
|
15611
16403
|
"required_fields": [
|
|
@@ -15643,6 +16435,8 @@
|
|
|
15643
16435
|
"x-validation-rules": {
|
|
15644
16436
|
"ves.io.schema.rules.string.max_bytes": "256"
|
|
15645
16437
|
},
|
|
16438
|
+
"x-f5xc-description-short": "Exclusive with [client_name_matcher client_selector] The name of the client trying to access the secret.",
|
|
16439
|
+
"x-f5xc-description-medium": "Exclusive with [client_name_matcher client_selector] The name of the client trying to access the secret. Name of the client will be extracted from client TLS certificate. This predicate evaluates to true if client name matches the configured name.",
|
|
15646
16440
|
"minLength": 0,
|
|
15647
16441
|
"x-f5xc-required-for": {
|
|
15648
16442
|
"minimum_config": false,
|
|
@@ -15658,6 +16452,7 @@
|
|
|
15658
16452
|
"$ref": "#/components/schemas/schemaLabelSelectorType"
|
|
15659
16453
|
}
|
|
15660
16454
|
},
|
|
16455
|
+
"x-f5xc-description-short": "Create secret_policy_rule creates a new object in storage backend for metadata.namespace.",
|
|
15661
16456
|
"x-f5xc-minimum-configuration": {
|
|
15662
16457
|
"description": "Minimum configuration for schemasecret_policy_ruleCreateSpecType",
|
|
15663
16458
|
"required_fields": [
|
|
@@ -15697,6 +16492,8 @@
|
|
|
15697
16492
|
"x-validation-rules": {
|
|
15698
16493
|
"ves.io.schema.rules.string.max_bytes": "256"
|
|
15699
16494
|
},
|
|
16495
|
+
"x-f5xc-description-short": "Exclusive with [client_name_matcher client_selector] The name of the client trying to access the secret.",
|
|
16496
|
+
"x-f5xc-description-medium": "Exclusive with [client_name_matcher client_selector] The name of the client trying to access the secret. Name of the client will be extracted from client TLS certificate. This predicate evaluates to true if client name matches the configured name.",
|
|
15700
16497
|
"minLength": 0,
|
|
15701
16498
|
"x-f5xc-required-for": {
|
|
15702
16499
|
"minimum_config": false,
|
|
@@ -15712,6 +16509,7 @@
|
|
|
15712
16509
|
"$ref": "#/components/schemas/schemaLabelSelectorType"
|
|
15713
16510
|
}
|
|
15714
16511
|
},
|
|
16512
|
+
"x-f5xc-description-short": "GET secret_policy_rule reads a given object from storage backend for metadata.namespace.",
|
|
15715
16513
|
"x-f5xc-minimum-configuration": {
|
|
15716
16514
|
"description": "Minimum configuration for schemasecret_policy_ruleGetSpecType",
|
|
15717
16515
|
"required_fields": [
|
|
@@ -15751,6 +16549,8 @@
|
|
|
15751
16549
|
"x-validation-rules": {
|
|
15752
16550
|
"ves.io.schema.rules.string.max_bytes": "256"
|
|
15753
16551
|
},
|
|
16552
|
+
"x-f5xc-description-short": "Exclusive with [client_name_matcher client_selector] The name of the client trying to access the secret.",
|
|
16553
|
+
"x-f5xc-description-medium": "Exclusive with [client_name_matcher client_selector] The name of the client trying to access the secret. Name of the client will be extracted from client TLS certificate. This predicate evaluates to true if client name matches the configured name.",
|
|
15754
16554
|
"minLength": 0,
|
|
15755
16555
|
"x-f5xc-required-for": {
|
|
15756
16556
|
"minimum_config": false,
|
|
@@ -15766,6 +16566,7 @@
|
|
|
15766
16566
|
"$ref": "#/components/schemas/schemaLabelSelectorType"
|
|
15767
16567
|
}
|
|
15768
16568
|
},
|
|
16569
|
+
"x-f5xc-description-short": "Replace secret_policy_rule creates a new object in storage backend for metadata.namespace.",
|
|
15769
16570
|
"x-f5xc-minimum-configuration": {
|
|
15770
16571
|
"description": "Minimum configuration for schemasecret_policy_ruleReplaceSpecType",
|
|
15771
16572
|
"required_fields": [
|
|
@@ -15849,6 +16650,7 @@
|
|
|
15849
16650
|
"title": "Fail_if_referred.",
|
|
15850
16651
|
"format": "boolean",
|
|
15851
16652
|
"x-displayname": "Fail-If-Referred.",
|
|
16653
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
15852
16654
|
"x-f5xc-required-for": {
|
|
15853
16655
|
"minimum_config": false,
|
|
15854
16656
|
"create": false,
|
|
@@ -15873,7 +16675,7 @@
|
|
|
15873
16675
|
},
|
|
15874
16676
|
"x-original-maxLength": 1024,
|
|
15875
16677
|
"x-reconciled-from-discovery": true,
|
|
15876
|
-
"x-reconciled-at": "2026-01-
|
|
16678
|
+
"x-reconciled-at": "2026-01-07T15:29:16.904878+00:00"
|
|
15877
16679
|
},
|
|
15878
16680
|
"namespace": {
|
|
15879
16681
|
"type": "string",
|
|
@@ -15882,6 +16684,7 @@
|
|
|
15882
16684
|
"x-displayname": "Namespace",
|
|
15883
16685
|
"x-ves-example": "Ns1",
|
|
15884
16686
|
"x-f5xc-example": "ns1",
|
|
16687
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
15885
16688
|
"minLength": 0,
|
|
15886
16689
|
"maxLength": 6,
|
|
15887
16690
|
"x-f5xc-required-for": {
|
|
@@ -15892,7 +16695,7 @@
|
|
|
15892
16695
|
},
|
|
15893
16696
|
"x-original-maxLength": 1024,
|
|
15894
16697
|
"x-reconciled-from-discovery": true,
|
|
15895
|
-
"x-reconciled-at": "2026-01-
|
|
16698
|
+
"x-reconciled-at": "2026-01-07T15:29:16.904882+00:00"
|
|
15896
16699
|
}
|
|
15897
16700
|
},
|
|
15898
16701
|
"x-f5xc-minimum-configuration": {
|
|
@@ -15927,6 +16730,7 @@
|
|
|
15927
16730
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
15928
16731
|
},
|
|
15929
16732
|
"x-displayname": "Deleted Referred Objects.",
|
|
16733
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
15930
16734
|
"x-f5xc-required-for": {
|
|
15931
16735
|
"minimum_config": false,
|
|
15932
16736
|
"create": false,
|
|
@@ -15942,6 +16746,7 @@
|
|
|
15942
16746
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
15943
16747
|
},
|
|
15944
16748
|
"x-displayname": "Disabled Referred Objects.",
|
|
16749
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
15945
16750
|
"x-f5xc-required-for": {
|
|
15946
16751
|
"minimum_config": false,
|
|
15947
16752
|
"create": false,
|
|
@@ -15960,6 +16765,7 @@
|
|
|
15960
16765
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
15961
16766
|
},
|
|
15962
16767
|
"x-displayname": "Referring Objects.",
|
|
16768
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
15963
16769
|
"x-f5xc-required-for": {
|
|
15964
16770
|
"minimum_config": false,
|
|
15965
16771
|
"create": false,
|
|
@@ -15981,6 +16787,8 @@
|
|
|
15981
16787
|
"$ref": "#/components/schemas/secret_policy_ruleStatusObject"
|
|
15982
16788
|
},
|
|
15983
16789
|
"x-displayname": "Status",
|
|
16790
|
+
"x-f5xc-example": "active",
|
|
16791
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
15984
16792
|
"x-f5xc-required-for": {
|
|
15985
16793
|
"minimum_config": false,
|
|
15986
16794
|
"create": false,
|
|
@@ -15990,7 +16798,7 @@
|
|
|
15990
16798
|
"maxLength": 17,
|
|
15991
16799
|
"minLength": 17,
|
|
15992
16800
|
"x-reconciled-from-discovery": true,
|
|
15993
|
-
"x-reconciled-at": "2026-01-
|
|
16801
|
+
"x-reconciled-at": "2026-01-07T15:29:16.904897+00:00"
|
|
15994
16802
|
},
|
|
15995
16803
|
"system_metadata": {
|
|
15996
16804
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -16030,6 +16838,8 @@
|
|
|
16030
16838
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
16031
16839
|
],
|
|
16032
16840
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
16841
|
+
"x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
|
|
16842
|
+
"x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
|
|
16033
16843
|
"x-f5xc-minimum-configuration": {
|
|
16034
16844
|
"description": "Minimum configuration for secret_policy_ruleGetResponseFormatCode",
|
|
16035
16845
|
"required_fields": [],
|
|
@@ -16055,6 +16865,7 @@
|
|
|
16055
16865
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
16056
16866
|
},
|
|
16057
16867
|
"x-displayname": "Errors",
|
|
16868
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
16058
16869
|
"x-f5xc-required-for": {
|
|
16059
16870
|
"minimum_config": false,
|
|
16060
16871
|
"create": false,
|
|
@@ -16070,6 +16881,8 @@
|
|
|
16070
16881
|
"$ref": "#/components/schemas/secret_policy_ruleListResponseItem"
|
|
16071
16882
|
},
|
|
16072
16883
|
"x-displayname": "Items",
|
|
16884
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
16885
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
16073
16886
|
"x-f5xc-required-for": {
|
|
16074
16887
|
"minimum_config": false,
|
|
16075
16888
|
"create": false,
|
|
@@ -16103,6 +16916,8 @@
|
|
|
16103
16916
|
"description": "The set of annotations present on this secret_policy_rule.",
|
|
16104
16917
|
"title": "Annotations.",
|
|
16105
16918
|
"x-displayname": "Annotations.",
|
|
16919
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
16920
|
+
"x-f5xc-description-short": "The set of annotations present on this secret_policy_rule.",
|
|
16106
16921
|
"x-f5xc-required-for": {
|
|
16107
16922
|
"minimum_config": false,
|
|
16108
16923
|
"create": false,
|
|
@@ -16115,6 +16930,7 @@
|
|
|
16115
16930
|
"description": "The description set for this secret_policy_rule.",
|
|
16116
16931
|
"title": "Description.",
|
|
16117
16932
|
"x-displayname": "Description.",
|
|
16933
|
+
"x-f5xc-description-short": "The description set for this secret_policy_rule.",
|
|
16118
16934
|
"minLength": 0,
|
|
16119
16935
|
"maxLength": 0,
|
|
16120
16936
|
"x-f5xc-required-for": {
|
|
@@ -16125,7 +16941,7 @@
|
|
|
16125
16941
|
},
|
|
16126
16942
|
"x-original-maxLength": 1024,
|
|
16127
16943
|
"x-reconciled-from-discovery": true,
|
|
16128
|
-
"x-reconciled-at": "2026-01-
|
|
16944
|
+
"x-reconciled-at": "2026-01-07T15:29:16.904909+00:00"
|
|
16129
16945
|
},
|
|
16130
16946
|
"disabled": {
|
|
16131
16947
|
"type": "boolean",
|
|
@@ -16133,6 +16949,8 @@
|
|
|
16133
16949
|
"title": "Disabled",
|
|
16134
16950
|
"format": "boolean",
|
|
16135
16951
|
"x-displayname": "Disabled",
|
|
16952
|
+
"x-f5xc-example": "True",
|
|
16953
|
+
"x-f5xc-description-short": "Value of true indicates secret_policy_rule is administratively disabled.",
|
|
16136
16954
|
"x-f5xc-required-for": {
|
|
16137
16955
|
"minimum_config": false,
|
|
16138
16956
|
"create": false,
|
|
@@ -16148,6 +16966,8 @@
|
|
|
16148
16966
|
"description": "The set of labels present on this secret_policy_rule.",
|
|
16149
16967
|
"title": "Labels",
|
|
16150
16968
|
"x-displayname": "Labels",
|
|
16969
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
16970
|
+
"x-f5xc-description-short": "The set of labels present on this secret_policy_rule.",
|
|
16151
16971
|
"x-f5xc-required-for": {
|
|
16152
16972
|
"minimum_config": false,
|
|
16153
16973
|
"create": false,
|
|
@@ -16175,7 +16995,7 @@
|
|
|
16175
16995
|
},
|
|
16176
16996
|
"x-original-maxLength": 1024,
|
|
16177
16997
|
"x-reconciled-from-discovery": true,
|
|
16178
|
-
"x-reconciled-at": "2026-01-
|
|
16998
|
+
"x-reconciled-at": "2026-01-07T15:29:16.904918+00:00"
|
|
16179
16999
|
},
|
|
16180
17000
|
"namespace": {
|
|
16181
17001
|
"type": "string",
|
|
@@ -16194,7 +17014,7 @@
|
|
|
16194
17014
|
},
|
|
16195
17015
|
"x-original-maxLength": 1024,
|
|
16196
17016
|
"x-reconciled-from-discovery": true,
|
|
16197
|
-
"x-reconciled-at": "2026-01-
|
|
17017
|
+
"x-reconciled-at": "2026-01-07T15:29:16.904922+00:00"
|
|
16198
17018
|
},
|
|
16199
17019
|
"owner_view": {
|
|
16200
17020
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -16207,6 +17027,7 @@
|
|
|
16207
17027
|
"$ref": "#/components/schemas/secret_policy_ruleStatusObject"
|
|
16208
17028
|
},
|
|
16209
17029
|
"x-displayname": "Status",
|
|
17030
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
16210
17031
|
"x-f5xc-required-for": {
|
|
16211
17032
|
"minimum_config": false,
|
|
16212
17033
|
"create": false,
|
|
@@ -16235,7 +17056,7 @@
|
|
|
16235
17056
|
"x-field-mutability": "read-only",
|
|
16236
17057
|
"x-original-maxLength": 1024,
|
|
16237
17058
|
"x-reconciled-from-discovery": true,
|
|
16238
|
-
"x-reconciled-at": "2026-01-
|
|
17059
|
+
"x-reconciled-at": "2026-01-07T15:29:16.904930+00:00"
|
|
16239
17060
|
},
|
|
16240
17061
|
"uid": {
|
|
16241
17062
|
"type": "string",
|
|
@@ -16244,6 +17065,7 @@
|
|
|
16244
17065
|
"x-displayname": "UID",
|
|
16245
17066
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
16246
17067
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
17068
|
+
"x-f5xc-description-short": "The unique uid of this secret_policy_rule.",
|
|
16247
17069
|
"minLength": 0,
|
|
16248
17070
|
"maxLength": 36,
|
|
16249
17071
|
"x-f5xc-required-for": {
|
|
@@ -16256,9 +17078,11 @@
|
|
|
16256
17078
|
"x-original-maxLength": 1024,
|
|
16257
17079
|
"format": "uuid",
|
|
16258
17080
|
"x-reconciled-from-discovery": true,
|
|
16259
|
-
"x-reconciled-at": "2026-01-
|
|
17081
|
+
"x-reconciled-at": "2026-01-07T15:29:16.904935+00:00"
|
|
16260
17082
|
}
|
|
16261
17083
|
},
|
|
17084
|
+
"x-f5xc-description-short": "By default a summary of secret_policy_rule is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
17085
|
+
"x-f5xc-description-medium": "By default a summary of secret_policy_rule is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
16262
17086
|
"x-f5xc-minimum-configuration": {
|
|
16263
17087
|
"description": "Minimum configuration for secret_policy_ruleListResponseItem",
|
|
16264
17088
|
"required_fields": [
|
|
@@ -16364,6 +17188,7 @@
|
|
|
16364
17188
|
}
|
|
16365
17189
|
}
|
|
16366
17190
|
},
|
|
17191
|
+
"x-f5xc-description-short": "Most recent observed status of the object.",
|
|
16367
17192
|
"x-f5xc-minimum-configuration": {
|
|
16368
17193
|
"description": "Minimum configuration for secret_policy_ruleStatusObject",
|
|
16369
17194
|
"required_fields": [
|
|
@@ -16395,6 +17220,8 @@
|
|
|
16395
17220
|
"x-displayname": "Maximum Duration for Validity.",
|
|
16396
17221
|
"x-ves-example": "72h",
|
|
16397
17222
|
"x-f5xc-example": "72h",
|
|
17223
|
+
"x-f5xc-description-short": "Max_validity_duration contains the maximum amount of time a secret from any users from this team/tenant is valid.",
|
|
17224
|
+
"x-f5xc-description-medium": "Max_validity_duration contains the maximum amount of time a secret from any users from this team/tenant is valid. Value for this parameter is a string ending in the suffix \"s\" (indicating seconds), suffix \"m\" (indicating minutes) or suffix \"h\" (indicating hours).",
|
|
16398
17225
|
"minLength": 0,
|
|
16399
17226
|
"maxLength": 1024,
|
|
16400
17227
|
"x-f5xc-required-for": {
|
|
@@ -16418,6 +17245,8 @@
|
|
|
16418
17245
|
"x-validation-rules": {
|
|
16419
17246
|
"ves.io.schema.rules.repeated.max_items": "16"
|
|
16420
17247
|
},
|
|
17248
|
+
"x-f5xc-description-short": "User_restrictions contains per tenant/team list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare.",
|
|
17249
|
+
"x-f5xc-description-medium": "User_restrictions contains per tenant/team list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare.",
|
|
16421
17250
|
"x-f5xc-required-for": {
|
|
16422
17251
|
"minimum_config": false,
|
|
16423
17252
|
"create": false,
|
|
@@ -16426,6 +17255,7 @@
|
|
|
16426
17255
|
}
|
|
16427
17256
|
}
|
|
16428
17257
|
},
|
|
17258
|
+
"x-f5xc-description-short": "Create voltshare_admin_policy creates a new object in the storage backend for metadata.namespace.",
|
|
16429
17259
|
"x-f5xc-minimum-configuration": {
|
|
16430
17260
|
"description": "Minimum configuration for schemavoltshare_admin_policyCreateSpecType",
|
|
16431
17261
|
"required_fields": [
|
|
@@ -16457,6 +17287,8 @@
|
|
|
16457
17287
|
"x-displayname": "Maximum Duration for Validity.",
|
|
16458
17288
|
"x-ves-example": "72h",
|
|
16459
17289
|
"x-f5xc-example": "72h",
|
|
17290
|
+
"x-f5xc-description-short": "Max_validity_duration contains the maximum amount of time a secret from any users from this team/tenant is valid.",
|
|
17291
|
+
"x-f5xc-description-medium": "Max_validity_duration contains the maximum amount of time a secret from any users from this team/tenant is valid. Value for this parameter is a string ending in the suffix \"s\" (indicating seconds), suffix \"m\" (indicating minutes) or suffix \"h\" (indicating hours).",
|
|
16460
17292
|
"minLength": 0,
|
|
16461
17293
|
"maxLength": 1024,
|
|
16462
17294
|
"x-f5xc-required-for": {
|
|
@@ -16480,6 +17312,8 @@
|
|
|
16480
17312
|
"x-validation-rules": {
|
|
16481
17313
|
"ves.io.schema.rules.repeated.max_items": "16"
|
|
16482
17314
|
},
|
|
17315
|
+
"x-f5xc-description-short": "User_restrictions contains per tenant/team list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare.",
|
|
17316
|
+
"x-f5xc-description-medium": "User_restrictions contains per tenant/team list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare.",
|
|
16483
17317
|
"x-f5xc-required-for": {
|
|
16484
17318
|
"minimum_config": false,
|
|
16485
17319
|
"create": false,
|
|
@@ -16488,6 +17322,7 @@
|
|
|
16488
17322
|
}
|
|
16489
17323
|
}
|
|
16490
17324
|
},
|
|
17325
|
+
"x-f5xc-description-short": "GET voltshare_admin_policy reads a given object from storage backend for metadata.namespace.",
|
|
16491
17326
|
"x-f5xc-minimum-configuration": {
|
|
16492
17327
|
"description": "Minimum configuration for schemavoltshare_admin_policyGetSpecType",
|
|
16493
17328
|
"required_fields": [
|
|
@@ -16528,6 +17363,7 @@
|
|
|
16528
17363
|
"ves.io.schema.rules.string.max_bytes": "256",
|
|
16529
17364
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
16530
17365
|
},
|
|
17366
|
+
"x-f5xc-description-short": "Exclusive with [regex_pattern] exact_match contains user_id to match against.",
|
|
16531
17367
|
"x-f5xc-required-for": {
|
|
16532
17368
|
"minimum_config": false,
|
|
16533
17369
|
"create": false,
|
|
@@ -16552,6 +17388,7 @@
|
|
|
16552
17388
|
"ves.io.schema.rules.string.min_bytes": "1",
|
|
16553
17389
|
"ves.io.schema.rules.string.regex": "true"
|
|
16554
17390
|
},
|
|
17391
|
+
"x-f5xc-description-short": "Exclusive with [exact_value] regex_values contains a regex pattern to match against.",
|
|
16555
17392
|
"x-f5xc-required-for": {
|
|
16556
17393
|
"minimum_config": false,
|
|
16557
17394
|
"create": false,
|
|
@@ -16560,6 +17397,8 @@
|
|
|
16560
17397
|
}
|
|
16561
17398
|
}
|
|
16562
17399
|
},
|
|
17400
|
+
"x-f5xc-description-short": "MatcherType contains the choice of value to be compared against the input userid.",
|
|
17401
|
+
"x-f5xc-description-medium": "MatcherType contains the choice of value to be compared against the input userid. It could be a regex pattern or exact value.",
|
|
16563
17402
|
"x-f5xc-minimum-configuration": {
|
|
16564
17403
|
"description": "Minimum configuration for schemavoltshare_admin_policyMatcherType",
|
|
16565
17404
|
"required_fields": [
|
|
@@ -16590,6 +17429,8 @@
|
|
|
16590
17429
|
"x-displayname": "Maximum Duration for Validity.",
|
|
16591
17430
|
"x-ves-example": "72h",
|
|
16592
17431
|
"x-f5xc-example": "72h",
|
|
17432
|
+
"x-f5xc-description-short": "Max_validity_duration contains the maximum amount of time a secret from any users from this team/tenant is valid.",
|
|
17433
|
+
"x-f5xc-description-medium": "Max_validity_duration contains the maximum amount of time a secret from any users from this team/tenant is valid. Value for this parameter is a string ending in the suffix \"s\" (indicating seconds), suffix \"m\" (indicating minutes) or suffix \"h\" (indicating hours).",
|
|
16593
17434
|
"minLength": 0,
|
|
16594
17435
|
"maxLength": 1024,
|
|
16595
17436
|
"x-f5xc-required-for": {
|
|
@@ -16613,6 +17454,8 @@
|
|
|
16613
17454
|
"x-validation-rules": {
|
|
16614
17455
|
"ves.io.schema.rules.repeated.max_items": "16"
|
|
16615
17456
|
},
|
|
17457
|
+
"x-f5xc-description-short": "User_restrictions contains per tenant/team list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare.",
|
|
17458
|
+
"x-f5xc-description-medium": "User_restrictions contains per tenant/team list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare.",
|
|
16616
17459
|
"x-f5xc-required-for": {
|
|
16617
17460
|
"minimum_config": false,
|
|
16618
17461
|
"create": false,
|
|
@@ -16621,6 +17464,8 @@
|
|
|
16621
17464
|
}
|
|
16622
17465
|
}
|
|
16623
17466
|
},
|
|
17467
|
+
"x-f5xc-description-short": "Replace voltshare_admin_policy replaces an existing object in the storage backend for metadata.namespace.",
|
|
17468
|
+
"x-f5xc-description-medium": "Replace voltshare_admin_policy replaces an existing object in the storage backend for metadata.namespace.",
|
|
16624
17469
|
"x-f5xc-minimum-configuration": {
|
|
16625
17470
|
"description": "Minimum configuration for schemavoltshare_admin_policyReplaceSpecType",
|
|
16626
17471
|
"required_fields": [
|
|
@@ -16724,6 +17569,7 @@
|
|
|
16724
17569
|
}
|
|
16725
17570
|
}
|
|
16726
17571
|
},
|
|
17572
|
+
"x-f5xc-description-short": "Custom List contains user customized list of matcher values.",
|
|
16727
17573
|
"x-f5xc-minimum-configuration": {
|
|
16728
17574
|
"description": "Minimum configuration for voltshare_admin_policyCustomListType",
|
|
16729
17575
|
"required_fields": [
|
|
@@ -16749,6 +17595,7 @@
|
|
|
16749
17595
|
"title": "Fail_if_referred.",
|
|
16750
17596
|
"format": "boolean",
|
|
16751
17597
|
"x-displayname": "Fail-If-Referred.",
|
|
17598
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
16752
17599
|
"x-f5xc-required-for": {
|
|
16753
17600
|
"minimum_config": false,
|
|
16754
17601
|
"create": false,
|
|
@@ -16773,7 +17620,7 @@
|
|
|
16773
17620
|
},
|
|
16774
17621
|
"x-original-maxLength": 1024,
|
|
16775
17622
|
"x-reconciled-from-discovery": true,
|
|
16776
|
-
"x-reconciled-at": "2026-01-
|
|
17623
|
+
"x-reconciled-at": "2026-01-07T15:29:44.135801+00:00"
|
|
16777
17624
|
},
|
|
16778
17625
|
"namespace": {
|
|
16779
17626
|
"type": "string",
|
|
@@ -16782,6 +17629,7 @@
|
|
|
16782
17629
|
"x-displayname": "Namespace",
|
|
16783
17630
|
"x-ves-example": "Ns1",
|
|
16784
17631
|
"x-f5xc-example": "ns1",
|
|
17632
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
16785
17633
|
"minLength": 0,
|
|
16786
17634
|
"maxLength": 6,
|
|
16787
17635
|
"x-f5xc-required-for": {
|
|
@@ -16792,7 +17640,7 @@
|
|
|
16792
17640
|
},
|
|
16793
17641
|
"x-original-maxLength": 1024,
|
|
16794
17642
|
"x-reconciled-from-discovery": true,
|
|
16795
|
-
"x-reconciled-at": "2026-01-
|
|
17643
|
+
"x-reconciled-at": "2026-01-07T15:29:44.135805+00:00"
|
|
16796
17644
|
}
|
|
16797
17645
|
},
|
|
16798
17646
|
"x-f5xc-minimum-configuration": {
|
|
@@ -16827,6 +17675,7 @@
|
|
|
16827
17675
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
16828
17676
|
},
|
|
16829
17677
|
"x-displayname": "Deleted Referred Objects.",
|
|
17678
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
16830
17679
|
"x-f5xc-required-for": {
|
|
16831
17680
|
"minimum_config": false,
|
|
16832
17681
|
"create": false,
|
|
@@ -16842,6 +17691,7 @@
|
|
|
16842
17691
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
16843
17692
|
},
|
|
16844
17693
|
"x-displayname": "Disabled Referred Objects.",
|
|
17694
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
16845
17695
|
"x-f5xc-required-for": {
|
|
16846
17696
|
"minimum_config": false,
|
|
16847
17697
|
"create": false,
|
|
@@ -16860,6 +17710,7 @@
|
|
|
16860
17710
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
16861
17711
|
},
|
|
16862
17712
|
"x-displayname": "Referring Objects.",
|
|
17713
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
16863
17714
|
"x-f5xc-required-for": {
|
|
16864
17715
|
"minimum_config": false,
|
|
16865
17716
|
"create": false,
|
|
@@ -16881,6 +17732,8 @@
|
|
|
16881
17732
|
"$ref": "#/components/schemas/voltshare_admin_policyStatusObject"
|
|
16882
17733
|
},
|
|
16883
17734
|
"x-displayname": "Status",
|
|
17735
|
+
"x-f5xc-example": "active",
|
|
17736
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
16884
17737
|
"x-f5xc-required-for": {
|
|
16885
17738
|
"minimum_config": false,
|
|
16886
17739
|
"create": false,
|
|
@@ -16890,7 +17743,7 @@
|
|
|
16890
17743
|
"maxLength": 17,
|
|
16891
17744
|
"minLength": 17,
|
|
16892
17745
|
"x-reconciled-from-discovery": true,
|
|
16893
|
-
"x-reconciled-at": "2026-01-
|
|
17746
|
+
"x-reconciled-at": "2026-01-07T15:29:44.135820+00:00"
|
|
16894
17747
|
},
|
|
16895
17748
|
"system_metadata": {
|
|
16896
17749
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -16930,6 +17783,8 @@
|
|
|
16930
17783
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
16931
17784
|
],
|
|
16932
17785
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
17786
|
+
"x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
|
|
17787
|
+
"x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
|
|
16933
17788
|
"x-f5xc-minimum-configuration": {
|
|
16934
17789
|
"description": "Minimum configuration for voltshare_admin_policyGetResponseFormatCode",
|
|
16935
17790
|
"required_fields": [],
|
|
@@ -16955,6 +17810,7 @@
|
|
|
16955
17810
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
16956
17811
|
},
|
|
16957
17812
|
"x-displayname": "Errors",
|
|
17813
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
16958
17814
|
"x-f5xc-required-for": {
|
|
16959
17815
|
"minimum_config": false,
|
|
16960
17816
|
"create": false,
|
|
@@ -16970,6 +17826,8 @@
|
|
|
16970
17826
|
"$ref": "#/components/schemas/voltshare_admin_policyListResponseItem"
|
|
16971
17827
|
},
|
|
16972
17828
|
"x-displayname": "Items",
|
|
17829
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
17830
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
16973
17831
|
"x-f5xc-required-for": {
|
|
16974
17832
|
"minimum_config": false,
|
|
16975
17833
|
"create": false,
|
|
@@ -17003,6 +17861,8 @@
|
|
|
17003
17861
|
"description": "The set of annotations present on this voltshare_admin_policy.",
|
|
17004
17862
|
"title": "Annotations.",
|
|
17005
17863
|
"x-displayname": "Annotations.",
|
|
17864
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
17865
|
+
"x-f5xc-description-short": "The set of annotations present on this voltshare_admin_policy.",
|
|
17006
17866
|
"x-f5xc-required-for": {
|
|
17007
17867
|
"minimum_config": false,
|
|
17008
17868
|
"create": false,
|
|
@@ -17015,6 +17875,7 @@
|
|
|
17015
17875
|
"description": "The description set for this voltshare_admin_policy.",
|
|
17016
17876
|
"title": "Description.",
|
|
17017
17877
|
"x-displayname": "Description.",
|
|
17878
|
+
"x-f5xc-description-short": "The description set for this voltshare_admin_policy.",
|
|
17018
17879
|
"minLength": 0,
|
|
17019
17880
|
"maxLength": 0,
|
|
17020
17881
|
"x-f5xc-required-for": {
|
|
@@ -17025,7 +17886,7 @@
|
|
|
17025
17886
|
},
|
|
17026
17887
|
"x-original-maxLength": 1024,
|
|
17027
17888
|
"x-reconciled-from-discovery": true,
|
|
17028
|
-
"x-reconciled-at": "2026-01-
|
|
17889
|
+
"x-reconciled-at": "2026-01-07T15:29:44.135832+00:00"
|
|
17029
17890
|
},
|
|
17030
17891
|
"disabled": {
|
|
17031
17892
|
"type": "boolean",
|
|
@@ -17033,6 +17894,8 @@
|
|
|
17033
17894
|
"title": "Disabled",
|
|
17034
17895
|
"format": "boolean",
|
|
17035
17896
|
"x-displayname": "Disabled",
|
|
17897
|
+
"x-f5xc-example": "True",
|
|
17898
|
+
"x-f5xc-description-short": "Value of true indicates voltshare_admin_policy is administratively disabled.",
|
|
17036
17899
|
"x-f5xc-required-for": {
|
|
17037
17900
|
"minimum_config": false,
|
|
17038
17901
|
"create": false,
|
|
@@ -17048,6 +17911,8 @@
|
|
|
17048
17911
|
"description": "The set of labels present on this voltshare_admin_policy.",
|
|
17049
17912
|
"title": "Labels",
|
|
17050
17913
|
"x-displayname": "Labels",
|
|
17914
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
17915
|
+
"x-f5xc-description-short": "The set of labels present on this voltshare_admin_policy.",
|
|
17051
17916
|
"x-f5xc-required-for": {
|
|
17052
17917
|
"minimum_config": false,
|
|
17053
17918
|
"create": false,
|
|
@@ -17065,6 +17930,7 @@
|
|
|
17065
17930
|
"x-displayname": "Name",
|
|
17066
17931
|
"x-ves-example": "Name",
|
|
17067
17932
|
"x-f5xc-example": "name",
|
|
17933
|
+
"x-f5xc-description-short": "The name of this voltshare_admin_policy.",
|
|
17068
17934
|
"minLength": 0,
|
|
17069
17935
|
"maxLength": 16,
|
|
17070
17936
|
"x-f5xc-required-for": {
|
|
@@ -17075,7 +17941,7 @@
|
|
|
17075
17941
|
},
|
|
17076
17942
|
"x-original-maxLength": 1024,
|
|
17077
17943
|
"x-reconciled-from-discovery": true,
|
|
17078
|
-
"x-reconciled-at": "2026-01-
|
|
17944
|
+
"x-reconciled-at": "2026-01-07T15:29:44.135841+00:00"
|
|
17079
17945
|
},
|
|
17080
17946
|
"namespace": {
|
|
17081
17947
|
"type": "string",
|
|
@@ -17094,7 +17960,7 @@
|
|
|
17094
17960
|
},
|
|
17095
17961
|
"x-original-maxLength": 1024,
|
|
17096
17962
|
"x-reconciled-from-discovery": true,
|
|
17097
|
-
"x-reconciled-at": "2026-01-
|
|
17963
|
+
"x-reconciled-at": "2026-01-07T15:29:44.135845+00:00"
|
|
17098
17964
|
},
|
|
17099
17965
|
"owner_view": {
|
|
17100
17966
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -17107,6 +17973,7 @@
|
|
|
17107
17973
|
"$ref": "#/components/schemas/voltshare_admin_policyStatusObject"
|
|
17108
17974
|
},
|
|
17109
17975
|
"x-displayname": "Status",
|
|
17976
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
17110
17977
|
"x-f5xc-required-for": {
|
|
17111
17978
|
"minimum_config": false,
|
|
17112
17979
|
"create": false,
|
|
@@ -17135,7 +18002,7 @@
|
|
|
17135
18002
|
"x-field-mutability": "read-only",
|
|
17136
18003
|
"x-original-maxLength": 1024,
|
|
17137
18004
|
"x-reconciled-from-discovery": true,
|
|
17138
|
-
"x-reconciled-at": "2026-01-
|
|
18005
|
+
"x-reconciled-at": "2026-01-07T15:29:44.135853+00:00"
|
|
17139
18006
|
},
|
|
17140
18007
|
"uid": {
|
|
17141
18008
|
"type": "string",
|
|
@@ -17144,6 +18011,7 @@
|
|
|
17144
18011
|
"x-displayname": "UID",
|
|
17145
18012
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
17146
18013
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
18014
|
+
"x-f5xc-description-short": "The unique uid of this voltshare_admin_policy.",
|
|
17147
18015
|
"minLength": 0,
|
|
17148
18016
|
"maxLength": 36,
|
|
17149
18017
|
"x-f5xc-required-for": {
|
|
@@ -17156,9 +18024,11 @@
|
|
|
17156
18024
|
"x-original-maxLength": 1024,
|
|
17157
18025
|
"format": "uuid",
|
|
17158
18026
|
"x-reconciled-from-discovery": true,
|
|
17159
|
-
"x-reconciled-at": "2026-01-
|
|
18027
|
+
"x-reconciled-at": "2026-01-07T15:29:44.135858+00:00"
|
|
17160
18028
|
}
|
|
17161
18029
|
},
|
|
18030
|
+
"x-f5xc-description-short": "By default a summary of voltshare_admin_policy is returned in 'List'.",
|
|
18031
|
+
"x-f5xc-description-medium": "By default a summary of voltshare_admin_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
17162
18032
|
"x-f5xc-minimum-configuration": {
|
|
17163
18033
|
"description": "Minimum configuration for voltshare_admin_policyListResponseItem",
|
|
17164
18034
|
"required_fields": [
|
|
@@ -17238,6 +18108,7 @@
|
|
|
17238
18108
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
17239
18109
|
},
|
|
17240
18110
|
"x-displayname": "Conditions.",
|
|
18111
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
17241
18112
|
"x-f5xc-required-for": {
|
|
17242
18113
|
"minimum_config": false,
|
|
17243
18114
|
"create": false,
|
|
@@ -17264,6 +18135,7 @@
|
|
|
17264
18135
|
}
|
|
17265
18136
|
}
|
|
17266
18137
|
},
|
|
18138
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
17267
18139
|
"x-f5xc-minimum-configuration": {
|
|
17268
18140
|
"description": "Minimum configuration for voltshare_admin_policyStatusObject",
|
|
17269
18141
|
"required_fields": [
|
|
@@ -17300,6 +18172,7 @@
|
|
|
17300
18172
|
"$ref": "#/components/schemas/voltshare_admin_policyCustomListType"
|
|
17301
18173
|
}
|
|
17302
18174
|
},
|
|
18175
|
+
"x-f5xc-description-short": "User_matcher contains contains the allow/deny list of users/authors.",
|
|
17303
18176
|
"x-f5xc-minimum-configuration": {
|
|
17304
18177
|
"description": "Minimum configuration for voltshare_admin_policyUserMatcherType",
|
|
17305
18178
|
"required_fields": [
|
|
@@ -17345,6 +18218,8 @@
|
|
|
17345
18218
|
"ves.io.schema.rules.string.max_bytes": "256",
|
|
17346
18219
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
17347
18220
|
},
|
|
18221
|
+
"x-f5xc-example": "customer-123",
|
|
18222
|
+
"x-f5xc-description-short": "Exclusive with [all_tenants individual_users] Team/Tenant for which this rule is valid.",
|
|
17348
18223
|
"x-f5xc-required-for": {
|
|
17349
18224
|
"minimum_config": false,
|
|
17350
18225
|
"create": false,
|
|
@@ -17354,12 +18229,14 @@
|
|
|
17354
18229
|
"x-field-mutability": "read-only",
|
|
17355
18230
|
"x-original-maxLength": 256,
|
|
17356
18231
|
"x-reconciled-from-discovery": true,
|
|
17357
|
-
"x-reconciled-at": "2026-01-
|
|
18232
|
+
"x-reconciled-at": "2026-01-07T15:29:44.135878+00:00"
|
|
17358
18233
|
},
|
|
17359
18234
|
"user_restrictions": {
|
|
17360
18235
|
"$ref": "#/components/schemas/voltshare_admin_policyUserMatcherType"
|
|
17361
18236
|
}
|
|
17362
18237
|
},
|
|
18238
|
+
"x-f5xc-description-short": "User_restrictions contains list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare for any given team/tenant.",
|
|
18239
|
+
"x-f5xc-description-medium": "User_restrictions contains list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare for any given team/tenant.",
|
|
17363
18240
|
"x-f5xc-minimum-configuration": {
|
|
17364
18241
|
"description": "Minimum configuration for voltshare_admin_policyUserRestrictionType",
|
|
17365
18242
|
"required_fields": [
|