@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": "Bot And Threat Defense",
|
|
5
5
|
"description": "Behavioral fingerprinting identifies automated clients through request patterns, mouse movements, and JavaScript execution. Threat categories classify attacks by type including credential stuffing, scraping, and denial-of-service. Defense instances apply per-namespace policies with configurable sensitivity thresholds and challenge actions. Provisioning handles integration credentials for third-party threat intelligence feeds.",
|
|
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": "Threat classification with behavioral analysis and signature matching. Automated blocking for malicious traffic patterns.",
|
|
16
|
-
"x-f5xc-cli-domain": "bot_and_threat_defense"
|
|
16
|
+
"x-f5xc-cli-domain": "bot_and_threat_defense",
|
|
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
|
{
|
|
@@ -276,6 +326,13 @@
|
|
|
276
326
|
"latency": "low",
|
|
277
327
|
"resource_usage": "low"
|
|
278
328
|
}
|
|
329
|
+
},
|
|
330
|
+
"x-f5xc-discovered-response-time": {
|
|
331
|
+
"p50_ms": 1000,
|
|
332
|
+
"p95_ms": 3000,
|
|
333
|
+
"p99_ms": 8000,
|
|
334
|
+
"sample_count": 0,
|
|
335
|
+
"source": "estimate"
|
|
279
336
|
}
|
|
280
337
|
},
|
|
281
338
|
"x-displayname": "Bot Defense App Infrastructure.",
|
|
@@ -498,6 +555,13 @@
|
|
|
498
555
|
"latency": "low",
|
|
499
556
|
"resource_usage": "low"
|
|
500
557
|
}
|
|
558
|
+
},
|
|
559
|
+
"x-f5xc-discovered-response-time": {
|
|
560
|
+
"p50_ms": 800,
|
|
561
|
+
"p95_ms": 2500,
|
|
562
|
+
"p99_ms": 6000,
|
|
563
|
+
"sample_count": 0,
|
|
564
|
+
"source": "estimate"
|
|
501
565
|
}
|
|
502
566
|
},
|
|
503
567
|
"x-displayname": "Bot Defense App Infrastructure.",
|
|
@@ -725,6 +789,13 @@
|
|
|
725
789
|
"latency": "moderate",
|
|
726
790
|
"resource_usage": "moderate"
|
|
727
791
|
}
|
|
792
|
+
},
|
|
793
|
+
"x-f5xc-discovered-response-time": {
|
|
794
|
+
"p50_ms": 200,
|
|
795
|
+
"p95_ms": 800,
|
|
796
|
+
"p99_ms": 2000,
|
|
797
|
+
"sample_count": 0,
|
|
798
|
+
"source": "estimate"
|
|
728
799
|
}
|
|
729
800
|
},
|
|
730
801
|
"x-displayname": "Bot Defense App Infrastructure.",
|
|
@@ -945,6 +1016,13 @@
|
|
|
945
1016
|
"latency": "low",
|
|
946
1017
|
"resource_usage": "low"
|
|
947
1018
|
}
|
|
1019
|
+
},
|
|
1020
|
+
"x-f5xc-discovered-response-time": {
|
|
1021
|
+
"p50_ms": 200,
|
|
1022
|
+
"p95_ms": 800,
|
|
1023
|
+
"p99_ms": 2000,
|
|
1024
|
+
"sample_count": 0,
|
|
1025
|
+
"source": "estimate"
|
|
948
1026
|
}
|
|
949
1027
|
},
|
|
950
1028
|
"delete": {
|
|
@@ -1164,6 +1242,13 @@
|
|
|
1164
1242
|
"latency": "high",
|
|
1165
1243
|
"resource_usage": "moderate"
|
|
1166
1244
|
}
|
|
1245
|
+
},
|
|
1246
|
+
"x-f5xc-discovered-response-time": {
|
|
1247
|
+
"p50_ms": 500,
|
|
1248
|
+
"p95_ms": 1500,
|
|
1249
|
+
"p99_ms": 4000,
|
|
1250
|
+
"sample_count": 0,
|
|
1251
|
+
"source": "estimate"
|
|
1167
1252
|
}
|
|
1168
1253
|
},
|
|
1169
1254
|
"x-displayname": "Bot Defense App Infrastructure.",
|
|
@@ -1391,6 +1476,13 @@
|
|
|
1391
1476
|
"latency": "moderate",
|
|
1392
1477
|
"resource_usage": "moderate"
|
|
1393
1478
|
}
|
|
1479
|
+
},
|
|
1480
|
+
"x-f5xc-discovered-response-time": {
|
|
1481
|
+
"p50_ms": 200,
|
|
1482
|
+
"p95_ms": 800,
|
|
1483
|
+
"p99_ms": 2000,
|
|
1484
|
+
"sample_count": 0,
|
|
1485
|
+
"source": "estimate"
|
|
1394
1486
|
}
|
|
1395
1487
|
},
|
|
1396
1488
|
"x-displayname": "Shape Bot Defense Instance.",
|
|
@@ -1609,6 +1701,13 @@
|
|
|
1609
1701
|
"latency": "low",
|
|
1610
1702
|
"resource_usage": "low"
|
|
1611
1703
|
}
|
|
1704
|
+
},
|
|
1705
|
+
"x-f5xc-discovered-response-time": {
|
|
1706
|
+
"p50_ms": 200,
|
|
1707
|
+
"p95_ms": 800,
|
|
1708
|
+
"p99_ms": 2000,
|
|
1709
|
+
"sample_count": 0,
|
|
1710
|
+
"source": "estimate"
|
|
1612
1711
|
}
|
|
1613
1712
|
},
|
|
1614
1713
|
"x-displayname": "Shape Bot Defense Instance.",
|
|
@@ -1823,6 +1922,13 @@
|
|
|
1823
1922
|
"latency": "low",
|
|
1824
1923
|
"resource_usage": "low"
|
|
1825
1924
|
}
|
|
1925
|
+
},
|
|
1926
|
+
"x-f5xc-discovered-response-time": {
|
|
1927
|
+
"p50_ms": 1000,
|
|
1928
|
+
"p95_ms": 3000,
|
|
1929
|
+
"p99_ms": 8000,
|
|
1930
|
+
"sample_count": 0,
|
|
1931
|
+
"source": "estimate"
|
|
1826
1932
|
}
|
|
1827
1933
|
},
|
|
1828
1934
|
"x-displayname": "TPM API Key.",
|
|
@@ -2045,6 +2151,13 @@
|
|
|
2045
2151
|
"latency": "low",
|
|
2046
2152
|
"resource_usage": "low"
|
|
2047
2153
|
}
|
|
2154
|
+
},
|
|
2155
|
+
"x-f5xc-discovered-response-time": {
|
|
2156
|
+
"p50_ms": 800,
|
|
2157
|
+
"p95_ms": 2500,
|
|
2158
|
+
"p99_ms": 6000,
|
|
2159
|
+
"sample_count": 0,
|
|
2160
|
+
"source": "estimate"
|
|
2048
2161
|
}
|
|
2049
2162
|
},
|
|
2050
2163
|
"x-displayname": "TPM API Key.",
|
|
@@ -2272,6 +2385,13 @@
|
|
|
2272
2385
|
"latency": "moderate",
|
|
2273
2386
|
"resource_usage": "moderate"
|
|
2274
2387
|
}
|
|
2388
|
+
},
|
|
2389
|
+
"x-f5xc-discovered-response-time": {
|
|
2390
|
+
"p50_ms": 200,
|
|
2391
|
+
"p95_ms": 800,
|
|
2392
|
+
"p99_ms": 2000,
|
|
2393
|
+
"sample_count": 0,
|
|
2394
|
+
"source": "estimate"
|
|
2275
2395
|
}
|
|
2276
2396
|
},
|
|
2277
2397
|
"x-displayname": "TPM API Key.",
|
|
@@ -2493,6 +2613,13 @@
|
|
|
2493
2613
|
"latency": "low",
|
|
2494
2614
|
"resource_usage": "low"
|
|
2495
2615
|
}
|
|
2616
|
+
},
|
|
2617
|
+
"x-f5xc-discovered-response-time": {
|
|
2618
|
+
"p50_ms": 200,
|
|
2619
|
+
"p95_ms": 800,
|
|
2620
|
+
"p99_ms": 2000,
|
|
2621
|
+
"sample_count": 0,
|
|
2622
|
+
"source": "estimate"
|
|
2496
2623
|
}
|
|
2497
2624
|
},
|
|
2498
2625
|
"x-displayname": "TPM API Key.",
|
|
@@ -2707,6 +2834,13 @@
|
|
|
2707
2834
|
"latency": "low",
|
|
2708
2835
|
"resource_usage": "low"
|
|
2709
2836
|
}
|
|
2837
|
+
},
|
|
2838
|
+
"x-f5xc-discovered-response-time": {
|
|
2839
|
+
"p50_ms": 1000,
|
|
2840
|
+
"p95_ms": 3000,
|
|
2841
|
+
"p99_ms": 8000,
|
|
2842
|
+
"sample_count": 0,
|
|
2843
|
+
"source": "estimate"
|
|
2710
2844
|
}
|
|
2711
2845
|
},
|
|
2712
2846
|
"x-displayname": "TPM Category.",
|
|
@@ -2929,6 +3063,13 @@
|
|
|
2929
3063
|
"latency": "low",
|
|
2930
3064
|
"resource_usage": "low"
|
|
2931
3065
|
}
|
|
3066
|
+
},
|
|
3067
|
+
"x-f5xc-discovered-response-time": {
|
|
3068
|
+
"p50_ms": 800,
|
|
3069
|
+
"p95_ms": 2500,
|
|
3070
|
+
"p99_ms": 6000,
|
|
3071
|
+
"sample_count": 0,
|
|
3072
|
+
"source": "estimate"
|
|
2932
3073
|
}
|
|
2933
3074
|
},
|
|
2934
3075
|
"x-displayname": "TPM Category.",
|
|
@@ -3156,6 +3297,13 @@
|
|
|
3156
3297
|
"latency": "moderate",
|
|
3157
3298
|
"resource_usage": "moderate"
|
|
3158
3299
|
}
|
|
3300
|
+
},
|
|
3301
|
+
"x-f5xc-discovered-response-time": {
|
|
3302
|
+
"p50_ms": 200,
|
|
3303
|
+
"p95_ms": 800,
|
|
3304
|
+
"p99_ms": 2000,
|
|
3305
|
+
"sample_count": 0,
|
|
3306
|
+
"source": "estimate"
|
|
3159
3307
|
}
|
|
3160
3308
|
},
|
|
3161
3309
|
"x-displayname": "TPM Category.",
|
|
@@ -3377,6 +3525,13 @@
|
|
|
3377
3525
|
"latency": "low",
|
|
3378
3526
|
"resource_usage": "low"
|
|
3379
3527
|
}
|
|
3528
|
+
},
|
|
3529
|
+
"x-f5xc-discovered-response-time": {
|
|
3530
|
+
"p50_ms": 200,
|
|
3531
|
+
"p95_ms": 800,
|
|
3532
|
+
"p99_ms": 2000,
|
|
3533
|
+
"sample_count": 0,
|
|
3534
|
+
"source": "estimate"
|
|
3380
3535
|
}
|
|
3381
3536
|
},
|
|
3382
3537
|
"x-displayname": "TPM Category.",
|
|
@@ -3591,6 +3746,13 @@
|
|
|
3591
3746
|
"latency": "low",
|
|
3592
3747
|
"resource_usage": "low"
|
|
3593
3748
|
}
|
|
3749
|
+
},
|
|
3750
|
+
"x-f5xc-discovered-response-time": {
|
|
3751
|
+
"p50_ms": 1000,
|
|
3752
|
+
"p95_ms": 3000,
|
|
3753
|
+
"p99_ms": 8000,
|
|
3754
|
+
"sample_count": 0,
|
|
3755
|
+
"source": "estimate"
|
|
3594
3756
|
}
|
|
3595
3757
|
},
|
|
3596
3758
|
"x-displayname": "TPM Manager.",
|
|
@@ -3818,6 +3980,13 @@
|
|
|
3818
3980
|
"latency": "moderate",
|
|
3819
3981
|
"resource_usage": "moderate"
|
|
3820
3982
|
}
|
|
3983
|
+
},
|
|
3984
|
+
"x-f5xc-discovered-response-time": {
|
|
3985
|
+
"p50_ms": 200,
|
|
3986
|
+
"p95_ms": 800,
|
|
3987
|
+
"p99_ms": 2000,
|
|
3988
|
+
"sample_count": 0,
|
|
3989
|
+
"source": "estimate"
|
|
3821
3990
|
}
|
|
3822
3991
|
},
|
|
3823
3992
|
"x-displayname": "TPM Manager.",
|
|
@@ -4038,6 +4207,13 @@
|
|
|
4038
4207
|
"latency": "low",
|
|
4039
4208
|
"resource_usage": "low"
|
|
4040
4209
|
}
|
|
4210
|
+
},
|
|
4211
|
+
"x-f5xc-discovered-response-time": {
|
|
4212
|
+
"p50_ms": 200,
|
|
4213
|
+
"p95_ms": 800,
|
|
4214
|
+
"p99_ms": 2000,
|
|
4215
|
+
"sample_count": 0,
|
|
4216
|
+
"source": "estimate"
|
|
4041
4217
|
}
|
|
4042
4218
|
},
|
|
4043
4219
|
"x-displayname": "TPM Manager.",
|
|
@@ -4235,6 +4411,13 @@
|
|
|
4235
4411
|
"latency": "low",
|
|
4236
4412
|
"resource_usage": "low"
|
|
4237
4413
|
}
|
|
4414
|
+
},
|
|
4415
|
+
"x-f5xc-discovered-response-time": {
|
|
4416
|
+
"p50_ms": 1000,
|
|
4417
|
+
"p95_ms": 3000,
|
|
4418
|
+
"p99_ms": 8000,
|
|
4419
|
+
"sample_count": 0,
|
|
4420
|
+
"source": "estimate"
|
|
4238
4421
|
}
|
|
4239
4422
|
},
|
|
4240
4423
|
"x-displayname": "TPM Provisioning.",
|
|
@@ -4432,6 +4615,13 @@
|
|
|
4432
4615
|
"latency": "low",
|
|
4433
4616
|
"resource_usage": "low"
|
|
4434
4617
|
}
|
|
4618
|
+
},
|
|
4619
|
+
"x-f5xc-discovered-response-time": {
|
|
4620
|
+
"p50_ms": 1000,
|
|
4621
|
+
"p95_ms": 3000,
|
|
4622
|
+
"p99_ms": 8000,
|
|
4623
|
+
"sample_count": 0,
|
|
4624
|
+
"source": "estimate"
|
|
4435
4625
|
}
|
|
4436
4626
|
},
|
|
4437
4627
|
"x-displayname": "TPM Provisioning.",
|
|
@@ -4461,6 +4651,8 @@
|
|
|
4461
4651
|
"default": "US",
|
|
4462
4652
|
"x-displayname": "Bot Defense Advanced Region.",
|
|
4463
4653
|
"x-ves-proto-enum": "ves.io.schema.views.bot_defense_app_infrastructure.BotDefenseAdvancedRegion",
|
|
4654
|
+
"x-f5xc-description-short": "Defines a selection for Bot Defense Advanced region - US: US US region - EU: EU European Union region - ASIA: ASIA Asia region.",
|
|
4655
|
+
"x-f5xc-description-medium": "Defines a selection for Bot Defense Advanced region - US: US US region - EU: EU European Union region - ASIA: ASIA Asia region.",
|
|
4464
4656
|
"x-f5xc-minimum-configuration": {
|
|
4465
4657
|
"description": "Minimum configuration for bot_defense_app_infrastructureBotDefenseAdvancedRegion",
|
|
4466
4658
|
"required_fields": [],
|
|
@@ -4547,6 +4739,7 @@
|
|
|
4547
4739
|
"$ref": "#/components/schemas/bot_defense_app_infrastructureTrafficType"
|
|
4548
4740
|
}
|
|
4549
4741
|
},
|
|
4742
|
+
"x-f5xc-description-short": "Creates Bot Defense App Infrastructure in a given namespace.",
|
|
4550
4743
|
"x-f5xc-minimum-configuration": {
|
|
4551
4744
|
"description": "Minimum configuration for bot_defense_app_infrastructureCreateSpecType",
|
|
4552
4745
|
"required_fields": [
|
|
@@ -4575,6 +4768,7 @@
|
|
|
4575
4768
|
"title": "Fail_if_referred.",
|
|
4576
4769
|
"format": "boolean",
|
|
4577
4770
|
"x-displayname": "Fail-If-Referred.",
|
|
4771
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
4578
4772
|
"x-f5xc-required-for": {
|
|
4579
4773
|
"minimum_config": false,
|
|
4580
4774
|
"create": false,
|
|
@@ -4599,7 +4793,7 @@
|
|
|
4599
4793
|
},
|
|
4600
4794
|
"x-original-maxLength": 1024,
|
|
4601
4795
|
"x-reconciled-from-discovery": true,
|
|
4602
|
-
"x-reconciled-at": "2026-01-
|
|
4796
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949574+00:00"
|
|
4603
4797
|
},
|
|
4604
4798
|
"namespace": {
|
|
4605
4799
|
"type": "string",
|
|
@@ -4608,6 +4802,7 @@
|
|
|
4608
4802
|
"x-displayname": "Namespace",
|
|
4609
4803
|
"x-ves-example": "Ns1",
|
|
4610
4804
|
"x-f5xc-example": "ns1",
|
|
4805
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
4611
4806
|
"minLength": 0,
|
|
4612
4807
|
"maxLength": 6,
|
|
4613
4808
|
"x-f5xc-required-for": {
|
|
@@ -4618,7 +4813,7 @@
|
|
|
4618
4813
|
},
|
|
4619
4814
|
"x-original-maxLength": 1024,
|
|
4620
4815
|
"x-reconciled-from-discovery": true,
|
|
4621
|
-
"x-reconciled-at": "2026-01-
|
|
4816
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949580+00:00"
|
|
4622
4817
|
}
|
|
4623
4818
|
},
|
|
4624
4819
|
"x-f5xc-minimum-configuration": {
|
|
@@ -4695,6 +4890,7 @@
|
|
|
4695
4890
|
"default": "PRODUCTION",
|
|
4696
4891
|
"x-displayname": "Environment Type.",
|
|
4697
4892
|
"x-ves-proto-enum": "ves.io.schema.views.bot_defense_app_infrastructure.EnvironmentType",
|
|
4893
|
+
"x-f5xc-description-short": "Environment Type Production environment Testing environment.",
|
|
4698
4894
|
"x-f5xc-minimum-configuration": {
|
|
4699
4895
|
"description": "Minimum configuration for bot_defense_app_infrastructureEnvironmentType",
|
|
4700
4896
|
"required_fields": [],
|
|
@@ -4723,6 +4919,7 @@
|
|
|
4723
4919
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
4724
4920
|
},
|
|
4725
4921
|
"x-displayname": "Deleted Referred Objects.",
|
|
4922
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
4726
4923
|
"x-f5xc-required-for": {
|
|
4727
4924
|
"minimum_config": false,
|
|
4728
4925
|
"create": false,
|
|
@@ -4738,6 +4935,7 @@
|
|
|
4738
4935
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
4739
4936
|
},
|
|
4740
4937
|
"x-displayname": "Disabled Referred Objects.",
|
|
4938
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
4741
4939
|
"x-f5xc-required-for": {
|
|
4742
4940
|
"minimum_config": false,
|
|
4743
4941
|
"create": false,
|
|
@@ -4756,6 +4954,7 @@
|
|
|
4756
4954
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
4757
4955
|
},
|
|
4758
4956
|
"x-displayname": "Referring Objects.",
|
|
4957
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
4759
4958
|
"x-f5xc-required-for": {
|
|
4760
4959
|
"minimum_config": false,
|
|
4761
4960
|
"create": false,
|
|
@@ -4805,6 +5004,8 @@
|
|
|
4805
5004
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
4806
5005
|
],
|
|
4807
5006
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
5007
|
+
"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...",
|
|
5008
|
+
"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...",
|
|
4808
5009
|
"x-f5xc-minimum-configuration": {
|
|
4809
5010
|
"description": "Minimum configuration for bot_defense_app_infrastructureGetResponseFormatCode",
|
|
4810
5011
|
"required_fields": [],
|
|
@@ -4836,6 +5037,7 @@
|
|
|
4836
5037
|
"$ref": "#/components/schemas/bot_defense_app_infrastructureTrafficType"
|
|
4837
5038
|
}
|
|
4838
5039
|
},
|
|
5040
|
+
"x-f5xc-description-short": "GET Bot Defense App Infrastructure from a given namespace.",
|
|
4839
5041
|
"x-f5xc-minimum-configuration": {
|
|
4840
5042
|
"description": "Minimum configuration for bot_defense_app_infrastructureGetSpecType",
|
|
4841
5043
|
"required_fields": [
|
|
@@ -4978,6 +5180,8 @@
|
|
|
4978
5180
|
"x-validation-rules": {
|
|
4979
5181
|
"ves.io.schema.rules.string.hostname": "true"
|
|
4980
5182
|
},
|
|
5183
|
+
"x-f5xc-example": "example-resource",
|
|
5184
|
+
"x-f5xc-description-short": "Exclusive with [ip_address] Ingress Host Name.",
|
|
4981
5185
|
"minLength": 0,
|
|
4982
5186
|
"maxLength": 1024,
|
|
4983
5187
|
"x-f5xc-required-for": {
|
|
@@ -4999,6 +5203,7 @@
|
|
|
4999
5203
|
"ves.io.schema.rules.string.ip": "true"
|
|
5000
5204
|
},
|
|
5001
5205
|
"x-f5xc-example": "192.0.2.1",
|
|
5206
|
+
"x-f5xc-description-short": "Exclusive with [host_name] Ingress IP Address.",
|
|
5002
5207
|
"minLength": 0,
|
|
5003
5208
|
"maxLength": 1024,
|
|
5004
5209
|
"x-f5xc-required-for": {
|
|
@@ -5041,6 +5246,7 @@
|
|
|
5041
5246
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
5042
5247
|
},
|
|
5043
5248
|
"x-displayname": "Errors",
|
|
5249
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
5044
5250
|
"x-f5xc-required-for": {
|
|
5045
5251
|
"minimum_config": false,
|
|
5046
5252
|
"create": false,
|
|
@@ -5056,6 +5262,8 @@
|
|
|
5056
5262
|
"$ref": "#/components/schemas/bot_defense_app_infrastructureListResponseItem"
|
|
5057
5263
|
},
|
|
5058
5264
|
"x-displayname": "Items",
|
|
5265
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
5266
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
5059
5267
|
"x-f5xc-required-for": {
|
|
5060
5268
|
"minimum_config": false,
|
|
5061
5269
|
"create": false,
|
|
@@ -5089,6 +5297,8 @@
|
|
|
5089
5297
|
"description": "The set of annotations present on this bot_defense_app_infrastructure.",
|
|
5090
5298
|
"title": "Annotations.",
|
|
5091
5299
|
"x-displayname": "Annotations.",
|
|
5300
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
5301
|
+
"x-f5xc-description-short": "The set of annotations present on this bot_defense_app_infrastructure.",
|
|
5092
5302
|
"x-f5xc-required-for": {
|
|
5093
5303
|
"minimum_config": false,
|
|
5094
5304
|
"create": false,
|
|
@@ -5101,6 +5311,7 @@
|
|
|
5101
5311
|
"description": "The description set for this bot_defense_app_infrastructure.",
|
|
5102
5312
|
"title": "Description.",
|
|
5103
5313
|
"x-displayname": "Description.",
|
|
5314
|
+
"x-f5xc-description-short": "The description set for this bot_defense_app_infrastructure.",
|
|
5104
5315
|
"minLength": 0,
|
|
5105
5316
|
"maxLength": 0,
|
|
5106
5317
|
"x-f5xc-required-for": {
|
|
@@ -5111,7 +5322,7 @@
|
|
|
5111
5322
|
},
|
|
5112
5323
|
"x-original-maxLength": 1024,
|
|
5113
5324
|
"x-reconciled-from-discovery": true,
|
|
5114
|
-
"x-reconciled-at": "2026-01-
|
|
5325
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949620+00:00"
|
|
5115
5326
|
},
|
|
5116
5327
|
"disabled": {
|
|
5117
5328
|
"type": "boolean",
|
|
@@ -5119,6 +5330,8 @@
|
|
|
5119
5330
|
"title": "Disabled",
|
|
5120
5331
|
"format": "boolean",
|
|
5121
5332
|
"x-displayname": "Disabled",
|
|
5333
|
+
"x-f5xc-example": "True",
|
|
5334
|
+
"x-f5xc-description-short": "Value of true indicates bot_defense_app_infrastructure is administratively disabled.",
|
|
5122
5335
|
"x-f5xc-required-for": {
|
|
5123
5336
|
"minimum_config": false,
|
|
5124
5337
|
"create": false,
|
|
@@ -5134,6 +5347,8 @@
|
|
|
5134
5347
|
"description": "The set of labels present on this bot_defense_app_infrastructure.",
|
|
5135
5348
|
"title": "Labels",
|
|
5136
5349
|
"x-displayname": "Labels",
|
|
5350
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
5351
|
+
"x-f5xc-description-short": "The set of labels present on this bot_defense_app_infrastructure.",
|
|
5137
5352
|
"x-f5xc-required-for": {
|
|
5138
5353
|
"minimum_config": false,
|
|
5139
5354
|
"create": false,
|
|
@@ -5151,6 +5366,7 @@
|
|
|
5151
5366
|
"x-displayname": "Name",
|
|
5152
5367
|
"x-ves-example": "Name",
|
|
5153
5368
|
"x-f5xc-example": "name",
|
|
5369
|
+
"x-f5xc-description-short": "The name of this bot_defense_app_infrastructure.",
|
|
5154
5370
|
"minLength": 0,
|
|
5155
5371
|
"maxLength": 16,
|
|
5156
5372
|
"x-f5xc-required-for": {
|
|
@@ -5161,7 +5377,7 @@
|
|
|
5161
5377
|
},
|
|
5162
5378
|
"x-original-maxLength": 1024,
|
|
5163
5379
|
"x-reconciled-from-discovery": true,
|
|
5164
|
-
"x-reconciled-at": "2026-01-
|
|
5380
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949632+00:00"
|
|
5165
5381
|
},
|
|
5166
5382
|
"namespace": {
|
|
5167
5383
|
"type": "string",
|
|
@@ -5180,7 +5396,7 @@
|
|
|
5180
5396
|
},
|
|
5181
5397
|
"x-original-maxLength": 1024,
|
|
5182
5398
|
"x-reconciled-from-discovery": true,
|
|
5183
|
-
"x-reconciled-at": "2026-01-
|
|
5399
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949636+00:00"
|
|
5184
5400
|
},
|
|
5185
5401
|
"owner_view": {
|
|
5186
5402
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -5206,7 +5422,7 @@
|
|
|
5206
5422
|
"x-field-mutability": "read-only",
|
|
5207
5423
|
"x-original-maxLength": 1024,
|
|
5208
5424
|
"x-reconciled-from-discovery": true,
|
|
5209
|
-
"x-reconciled-at": "2026-01-
|
|
5425
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949643+00:00"
|
|
5210
5426
|
},
|
|
5211
5427
|
"uid": {
|
|
5212
5428
|
"type": "string",
|
|
@@ -5215,6 +5431,7 @@
|
|
|
5215
5431
|
"x-displayname": "UID",
|
|
5216
5432
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
5217
5433
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
5434
|
+
"x-f5xc-description-short": "The unique uid of this bot_defense_app_infrastructure.",
|
|
5218
5435
|
"minLength": 0,
|
|
5219
5436
|
"maxLength": 36,
|
|
5220
5437
|
"x-f5xc-required-for": {
|
|
@@ -5227,9 +5444,11 @@
|
|
|
5227
5444
|
"x-original-maxLength": 1024,
|
|
5228
5445
|
"format": "uuid",
|
|
5229
5446
|
"x-reconciled-from-discovery": true,
|
|
5230
|
-
"x-reconciled-at": "2026-01-
|
|
5447
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949649+00:00"
|
|
5231
5448
|
}
|
|
5232
5449
|
},
|
|
5450
|
+
"x-f5xc-description-short": "By default a summary of bot_defense_app_infrastructure is returned in 'List'.",
|
|
5451
|
+
"x-f5xc-description-medium": "By default a summary of bot_defense_app_infrastructure is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
5233
5452
|
"x-f5xc-minimum-configuration": {
|
|
5234
5453
|
"description": "Minimum configuration for bot_defense_app_infrastructureListResponseItem",
|
|
5235
5454
|
"required_fields": [
|
|
@@ -5314,6 +5533,7 @@
|
|
|
5314
5533
|
"$ref": "#/components/schemas/bot_defense_app_infrastructureTrafficType"
|
|
5315
5534
|
}
|
|
5316
5535
|
},
|
|
5536
|
+
"x-f5xc-description-short": "Replace a given Bot Defense App Infrastructure in a given namespace.",
|
|
5317
5537
|
"x-f5xc-minimum-configuration": {
|
|
5318
5538
|
"description": "Minimum configuration for bot_defense_app_infrastructureReplaceSpecType",
|
|
5319
5539
|
"required_fields": [
|
|
@@ -5340,6 +5560,7 @@
|
|
|
5340
5560
|
"default": "WEB",
|
|
5341
5561
|
"x-displayname": "Traffic Type.",
|
|
5342
5562
|
"x-ves-proto-enum": "ves.io.schema.views.bot_defense_app_infrastructure.TrafficType",
|
|
5563
|
+
"x-f5xc-description-short": "Traffic Type Web traffic Mobile traffic.",
|
|
5343
5564
|
"x-f5xc-minimum-configuration": {
|
|
5344
5565
|
"description": "Minimum configuration for bot_defense_app_infrastructureTrafficType",
|
|
5345
5566
|
"required_fields": [],
|
|
@@ -5364,6 +5585,8 @@
|
|
|
5364
5585
|
"x-displayname": "Kind",
|
|
5365
5586
|
"x-ves-example": "Virtual_site.",
|
|
5366
5587
|
"x-f5xc-example": "virtual_site",
|
|
5588
|
+
"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\")",
|
|
5589
|
+
"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\").",
|
|
5367
5590
|
"minLength": 0,
|
|
5368
5591
|
"maxLength": 14,
|
|
5369
5592
|
"x-f5xc-required-for": {
|
|
@@ -5375,7 +5598,7 @@
|
|
|
5375
5598
|
"readOnly": true,
|
|
5376
5599
|
"x-original-maxLength": 1024,
|
|
5377
5600
|
"x-reconciled-from-discovery": true,
|
|
5378
|
-
"x-reconciled-at": "2026-01-
|
|
5601
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949663+00:00"
|
|
5379
5602
|
},
|
|
5380
5603
|
"name": {
|
|
5381
5604
|
"type": "string",
|
|
@@ -5384,6 +5607,8 @@
|
|
|
5384
5607
|
"x-displayname": "Name",
|
|
5385
5608
|
"x-ves-example": "Contactus-route.",
|
|
5386
5609
|
"x-f5xc-example": "contactus-route",
|
|
5610
|
+
"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.",
|
|
5611
|
+
"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.",
|
|
5387
5612
|
"minLength": 0,
|
|
5388
5613
|
"maxLength": 16,
|
|
5389
5614
|
"x-f5xc-required-for": {
|
|
@@ -5394,7 +5619,7 @@
|
|
|
5394
5619
|
},
|
|
5395
5620
|
"x-original-maxLength": 1024,
|
|
5396
5621
|
"x-reconciled-from-discovery": true,
|
|
5397
|
-
"x-reconciled-at": "2026-01-
|
|
5622
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949668+00:00"
|
|
5398
5623
|
},
|
|
5399
5624
|
"namespace": {
|
|
5400
5625
|
"type": "string",
|
|
@@ -5403,6 +5628,8 @@
|
|
|
5403
5628
|
"x-displayname": "Namespace",
|
|
5404
5629
|
"x-ves-example": "Ns1",
|
|
5405
5630
|
"x-f5xc-example": "ns1",
|
|
5631
|
+
"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.",
|
|
5632
|
+
"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.",
|
|
5406
5633
|
"minLength": 0,
|
|
5407
5634
|
"maxLength": 6,
|
|
5408
5635
|
"x-f5xc-required-for": {
|
|
@@ -5413,7 +5640,7 @@
|
|
|
5413
5640
|
},
|
|
5414
5641
|
"x-original-maxLength": 1024,
|
|
5415
5642
|
"x-reconciled-from-discovery": true,
|
|
5416
|
-
"x-reconciled-at": "2026-01-
|
|
5643
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949672+00:00"
|
|
5417
5644
|
},
|
|
5418
5645
|
"tenant": {
|
|
5419
5646
|
"type": "string",
|
|
@@ -5422,6 +5649,8 @@
|
|
|
5422
5649
|
"x-displayname": "Tenant",
|
|
5423
5650
|
"x-ves-example": "Example-corp.",
|
|
5424
5651
|
"x-f5xc-example": "example-corp",
|
|
5652
|
+
"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.",
|
|
5653
|
+
"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.",
|
|
5425
5654
|
"minLength": 0,
|
|
5426
5655
|
"maxLength": 18,
|
|
5427
5656
|
"x-f5xc-required-for": {
|
|
@@ -5434,7 +5663,7 @@
|
|
|
5434
5663
|
"x-field-mutability": "read-only",
|
|
5435
5664
|
"x-original-maxLength": 1024,
|
|
5436
5665
|
"x-reconciled-from-discovery": true,
|
|
5437
|
-
"x-reconciled-at": "2026-01-
|
|
5666
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949676+00:00"
|
|
5438
5667
|
},
|
|
5439
5668
|
"uid": {
|
|
5440
5669
|
"type": "string",
|
|
@@ -5443,6 +5672,8 @@
|
|
|
5443
5672
|
"x-displayname": "UID",
|
|
5444
5673
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
5445
5674
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
5675
|
+
"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.",
|
|
5676
|
+
"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.",
|
|
5446
5677
|
"minLength": 0,
|
|
5447
5678
|
"maxLength": 36,
|
|
5448
5679
|
"x-f5xc-required-for": {
|
|
@@ -5456,9 +5687,11 @@
|
|
|
5456
5687
|
"x-original-maxLength": 1024,
|
|
5457
5688
|
"format": "uuid",
|
|
5458
5689
|
"x-reconciled-from-discovery": true,
|
|
5459
|
-
"x-reconciled-at": "2026-01-
|
|
5690
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949682+00:00"
|
|
5460
5691
|
}
|
|
5461
5692
|
},
|
|
5693
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
5694
|
+
"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...",
|
|
5462
5695
|
"x-f5xc-minimum-configuration": {
|
|
5463
5696
|
"description": "Minimum configuration for ioschemaObjectRefType",
|
|
5464
5697
|
"required_fields": [
|
|
@@ -5482,6 +5715,8 @@
|
|
|
5482
5715
|
"type_url": {
|
|
5483
5716
|
"type": "string",
|
|
5484
5717
|
"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.",
|
|
5718
|
+
"x-f5xc-description-short": "URL identifying the protocol buffer message type.",
|
|
5719
|
+
"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 ).",
|
|
5485
5720
|
"minLength": 0,
|
|
5486
5721
|
"maxLength": 1024,
|
|
5487
5722
|
"x-f5xc-required-for": {
|
|
@@ -5505,9 +5740,11 @@
|
|
|
5505
5740
|
},
|
|
5506
5741
|
"x-original-maxLength": 1024,
|
|
5507
5742
|
"x-reconciled-from-discovery": true,
|
|
5508
|
-
"x-reconciled-at": "2026-01-
|
|
5743
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949688+00:00"
|
|
5509
5744
|
}
|
|
5510
5745
|
},
|
|
5746
|
+
"x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
|
|
5747
|
+
"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...",
|
|
5511
5748
|
"x-f5xc-minimum-configuration": {
|
|
5512
5749
|
"description": "Minimum configuration for protobufAny",
|
|
5513
5750
|
"required_fields": [
|
|
@@ -5539,6 +5776,8 @@
|
|
|
5539
5776
|
"default": "EOK",
|
|
5540
5777
|
"x-displayname": "Error Code.",
|
|
5541
5778
|
"x-ves-proto-enum": "ves.io.schema.ErrorCode",
|
|
5779
|
+
"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...",
|
|
5780
|
+
"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...",
|
|
5542
5781
|
"x-f5xc-minimum-configuration": {
|
|
5543
5782
|
"description": "Minimum configuration for schemaErrorCode",
|
|
5544
5783
|
"required_fields": [],
|
|
@@ -5579,6 +5818,7 @@
|
|
|
5579
5818
|
}
|
|
5580
5819
|
}
|
|
5581
5820
|
},
|
|
5821
|
+
"x-f5xc-description-short": "Information about a error in API operation.",
|
|
5582
5822
|
"x-f5xc-minimum-configuration": {
|
|
5583
5823
|
"description": "Minimum configuration for schemaErrorType",
|
|
5584
5824
|
"required_fields": [
|
|
@@ -5606,6 +5846,7 @@
|
|
|
5606
5846
|
"title": "Name",
|
|
5607
5847
|
"x-displayname": "Name",
|
|
5608
5848
|
"x-f5xc-example": "example-resource",
|
|
5849
|
+
"x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
|
|
5609
5850
|
"minLength": 0,
|
|
5610
5851
|
"maxLength": 16,
|
|
5611
5852
|
"x-f5xc-required-for": {
|
|
@@ -5616,9 +5857,10 @@
|
|
|
5616
5857
|
},
|
|
5617
5858
|
"x-original-maxLength": 1024,
|
|
5618
5859
|
"x-reconciled-from-discovery": true,
|
|
5619
|
-
"x-reconciled-at": "2026-01-
|
|
5860
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949698+00:00"
|
|
5620
5861
|
}
|
|
5621
5862
|
},
|
|
5863
|
+
"x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
|
|
5622
5864
|
"x-f5xc-minimum-configuration": {
|
|
5623
5865
|
"description": "Minimum configuration for schemaInitializerType",
|
|
5624
5866
|
"required_fields": [
|
|
@@ -5646,6 +5888,8 @@
|
|
|
5646
5888
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
5647
5889
|
},
|
|
5648
5890
|
"x-displayname": "Pending",
|
|
5891
|
+
"x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
|
|
5892
|
+
"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.",
|
|
5649
5893
|
"x-f5xc-required-for": {
|
|
5650
5894
|
"minimum_config": false,
|
|
5651
5895
|
"create": false,
|
|
@@ -5657,6 +5901,7 @@
|
|
|
5657
5901
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
5658
5902
|
}
|
|
5659
5903
|
},
|
|
5904
|
+
"x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
|
|
5660
5905
|
"x-f5xc-minimum-configuration": {
|
|
5661
5906
|
"description": "Minimum configuration for schemaInitializersType",
|
|
5662
5907
|
"required_fields": [
|
|
@@ -5695,6 +5940,8 @@
|
|
|
5695
5940
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
5696
5941
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
5697
5942
|
},
|
|
5943
|
+
"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.",
|
|
5944
|
+
"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.",
|
|
5698
5945
|
"x-f5xc-required-for": {
|
|
5699
5946
|
"minimum_config": false,
|
|
5700
5947
|
"create": false,
|
|
@@ -5716,6 +5963,7 @@
|
|
|
5716
5963
|
"x-validation-rules": {
|
|
5717
5964
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
5718
5965
|
},
|
|
5966
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
5719
5967
|
"minLength": 0,
|
|
5720
5968
|
"x-f5xc-required-for": {
|
|
5721
5969
|
"minimum_config": false,
|
|
@@ -5725,7 +5973,7 @@
|
|
|
5725
5973
|
},
|
|
5726
5974
|
"x-original-maxLength": 1200,
|
|
5727
5975
|
"x-reconciled-from-discovery": true,
|
|
5728
|
-
"x-reconciled-at": "2026-01-
|
|
5976
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949708+00:00"
|
|
5729
5977
|
},
|
|
5730
5978
|
"disable": {
|
|
5731
5979
|
"type": "boolean",
|
|
@@ -5734,6 +5982,7 @@
|
|
|
5734
5982
|
"format": "boolean",
|
|
5735
5983
|
"x-displayname": "Disable",
|
|
5736
5984
|
"x-f5xc-example": "true",
|
|
5985
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
5737
5986
|
"x-f5xc-required-for": {
|
|
5738
5987
|
"minimum_config": false,
|
|
5739
5988
|
"create": false,
|
|
@@ -5747,6 +5996,8 @@
|
|
|
5747
5996
|
"title": "Labels",
|
|
5748
5997
|
"x-displayname": "Labels",
|
|
5749
5998
|
"x-f5xc-example": "value",
|
|
5999
|
+
"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.",
|
|
6000
|
+
"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.",
|
|
5750
6001
|
"x-f5xc-required-for": {
|
|
5751
6002
|
"minimum_config": false,
|
|
5752
6003
|
"create": false,
|
|
@@ -5768,6 +6019,8 @@
|
|
|
5768
6019
|
"x-validation-rules": {
|
|
5769
6020
|
"ves.io.schema.rules.message.required": "true"
|
|
5770
6021
|
},
|
|
6022
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
6023
|
+
"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.",
|
|
5771
6024
|
"minLength": 0,
|
|
5772
6025
|
"maxLength": 16,
|
|
5773
6026
|
"x-f5xc-required-for": {
|
|
@@ -5778,7 +6031,7 @@
|
|
|
5778
6031
|
},
|
|
5779
6032
|
"x-original-maxLength": 1024,
|
|
5780
6033
|
"x-reconciled-from-discovery": true,
|
|
5781
|
-
"x-reconciled-at": "2026-01-
|
|
6034
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949716+00:00"
|
|
5782
6035
|
},
|
|
5783
6036
|
"namespace": {
|
|
5784
6037
|
"type": "string",
|
|
@@ -5787,6 +6040,8 @@
|
|
|
5787
6040
|
"x-displayname": "Namespace",
|
|
5788
6041
|
"x-ves-example": "Staging",
|
|
5789
6042
|
"x-f5xc-example": "staging",
|
|
6043
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
6044
|
+
"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 \"\".",
|
|
5790
6045
|
"minLength": 0,
|
|
5791
6046
|
"maxLength": 6,
|
|
5792
6047
|
"x-f5xc-required-for": {
|
|
@@ -5797,9 +6052,10 @@
|
|
|
5797
6052
|
},
|
|
5798
6053
|
"x-original-maxLength": 1024,
|
|
5799
6054
|
"x-reconciled-from-discovery": true,
|
|
5800
|
-
"x-reconciled-at": "2026-01-
|
|
6055
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949720+00:00"
|
|
5801
6056
|
}
|
|
5802
6057
|
},
|
|
6058
|
+
"x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
|
|
5803
6059
|
"x-f5xc-minimum-configuration": {
|
|
5804
6060
|
"description": "Minimum configuration for schemaObjectCreateMetaType",
|
|
5805
6061
|
"required_fields": [
|
|
@@ -5843,6 +6099,8 @@
|
|
|
5843
6099
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
5844
6100
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
5845
6101
|
},
|
|
6102
|
+
"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.",
|
|
6103
|
+
"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.",
|
|
5846
6104
|
"x-f5xc-required-for": {
|
|
5847
6105
|
"minimum_config": false,
|
|
5848
6106
|
"create": false,
|
|
@@ -5864,6 +6122,7 @@
|
|
|
5864
6122
|
"x-validation-rules": {
|
|
5865
6123
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
5866
6124
|
},
|
|
6125
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
5867
6126
|
"minLength": 0,
|
|
5868
6127
|
"x-f5xc-required-for": {
|
|
5869
6128
|
"minimum_config": false,
|
|
@@ -5873,7 +6132,7 @@
|
|
|
5873
6132
|
},
|
|
5874
6133
|
"x-original-maxLength": 1200,
|
|
5875
6134
|
"x-reconciled-from-discovery": true,
|
|
5876
|
-
"x-reconciled-at": "2026-01-
|
|
6135
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949726+00:00"
|
|
5877
6136
|
},
|
|
5878
6137
|
"disable": {
|
|
5879
6138
|
"type": "boolean",
|
|
@@ -5883,6 +6142,7 @@
|
|
|
5883
6142
|
"x-displayname": "Disable",
|
|
5884
6143
|
"x-ves-example": "True",
|
|
5885
6144
|
"x-f5xc-example": "true",
|
|
6145
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
5886
6146
|
"x-f5xc-required-for": {
|
|
5887
6147
|
"minimum_config": false,
|
|
5888
6148
|
"create": false,
|
|
@@ -5897,6 +6157,8 @@
|
|
|
5897
6157
|
"x-displayname": "Labels",
|
|
5898
6158
|
"x-ves-example": "Value",
|
|
5899
6159
|
"x-f5xc-example": "value",
|
|
6160
|
+
"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.",
|
|
6161
|
+
"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.",
|
|
5900
6162
|
"x-f5xc-required-for": {
|
|
5901
6163
|
"minimum_config": false,
|
|
5902
6164
|
"create": false,
|
|
@@ -5918,6 +6180,8 @@
|
|
|
5918
6180
|
"x-validation-rules": {
|
|
5919
6181
|
"ves.io.schema.rules.message.required": "true"
|
|
5920
6182
|
},
|
|
6183
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
6184
|
+
"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.",
|
|
5921
6185
|
"minLength": 0,
|
|
5922
6186
|
"maxLength": 16,
|
|
5923
6187
|
"x-f5xc-required-for": {
|
|
@@ -5928,7 +6192,7 @@
|
|
|
5928
6192
|
},
|
|
5929
6193
|
"x-original-maxLength": 1024,
|
|
5930
6194
|
"x-reconciled-from-discovery": true,
|
|
5931
|
-
"x-reconciled-at": "2026-01-
|
|
6195
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949733+00:00"
|
|
5932
6196
|
},
|
|
5933
6197
|
"namespace": {
|
|
5934
6198
|
"type": "string",
|
|
@@ -5937,6 +6201,8 @@
|
|
|
5937
6201
|
"x-displayname": "Namespace",
|
|
5938
6202
|
"x-ves-example": "Staging",
|
|
5939
6203
|
"x-f5xc-example": "staging",
|
|
6204
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
6205
|
+
"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 \"\".",
|
|
5940
6206
|
"minLength": 0,
|
|
5941
6207
|
"maxLength": 6,
|
|
5942
6208
|
"x-f5xc-required-for": {
|
|
@@ -5947,9 +6213,10 @@
|
|
|
5947
6213
|
},
|
|
5948
6214
|
"x-original-maxLength": 1024,
|
|
5949
6215
|
"x-reconciled-from-discovery": true,
|
|
5950
|
-
"x-reconciled-at": "2026-01-
|
|
6216
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949737+00:00"
|
|
5951
6217
|
}
|
|
5952
6218
|
},
|
|
6219
|
+
"x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
|
|
5953
6220
|
"x-f5xc-minimum-configuration": {
|
|
5954
6221
|
"description": "Minimum configuration for schemaObjectGetMetaType",
|
|
5955
6222
|
"required_fields": [
|
|
@@ -5993,6 +6260,8 @@
|
|
|
5993
6260
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
5994
6261
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
5995
6262
|
},
|
|
6263
|
+
"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.",
|
|
6264
|
+
"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.",
|
|
5996
6265
|
"x-f5xc-required-for": {
|
|
5997
6266
|
"minimum_config": false,
|
|
5998
6267
|
"create": false,
|
|
@@ -6014,6 +6283,7 @@
|
|
|
6014
6283
|
"x-validation-rules": {
|
|
6015
6284
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
6016
6285
|
},
|
|
6286
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
6017
6287
|
"minLength": 0,
|
|
6018
6288
|
"x-f5xc-required-for": {
|
|
6019
6289
|
"minimum_config": false,
|
|
@@ -6023,7 +6293,7 @@
|
|
|
6023
6293
|
},
|
|
6024
6294
|
"x-original-maxLength": 1200,
|
|
6025
6295
|
"x-reconciled-from-discovery": true,
|
|
6026
|
-
"x-reconciled-at": "2026-01-
|
|
6296
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949744+00:00"
|
|
6027
6297
|
},
|
|
6028
6298
|
"disable": {
|
|
6029
6299
|
"type": "boolean",
|
|
@@ -6032,6 +6302,7 @@
|
|
|
6032
6302
|
"format": "boolean",
|
|
6033
6303
|
"x-displayname": "Disable",
|
|
6034
6304
|
"x-f5xc-example": "true",
|
|
6305
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
6035
6306
|
"x-f5xc-required-for": {
|
|
6036
6307
|
"minimum_config": false,
|
|
6037
6308
|
"create": false,
|
|
@@ -6046,6 +6317,8 @@
|
|
|
6046
6317
|
"x-displayname": "Labels",
|
|
6047
6318
|
"x-ves-example": "Value",
|
|
6048
6319
|
"x-f5xc-example": "value",
|
|
6320
|
+
"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.",
|
|
6321
|
+
"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.",
|
|
6049
6322
|
"x-f5xc-required-for": {
|
|
6050
6323
|
"minimum_config": false,
|
|
6051
6324
|
"create": false,
|
|
@@ -6066,6 +6339,8 @@
|
|
|
6066
6339
|
"x-validation-rules": {
|
|
6067
6340
|
"ves.io.schema.rules.message.required": "true"
|
|
6068
6341
|
},
|
|
6342
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
6343
|
+
"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.",
|
|
6069
6344
|
"minLength": 0,
|
|
6070
6345
|
"maxLength": 16,
|
|
6071
6346
|
"x-f5xc-required-for": {
|
|
@@ -6076,7 +6351,7 @@
|
|
|
6076
6351
|
},
|
|
6077
6352
|
"x-original-maxLength": 1024,
|
|
6078
6353
|
"x-reconciled-from-discovery": true,
|
|
6079
|
-
"x-reconciled-at": "2026-01-
|
|
6354
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949750+00:00"
|
|
6080
6355
|
},
|
|
6081
6356
|
"namespace": {
|
|
6082
6357
|
"type": "string",
|
|
@@ -6085,6 +6360,8 @@
|
|
|
6085
6360
|
"x-displayname": "Namespace",
|
|
6086
6361
|
"x-ves-example": "Staging",
|
|
6087
6362
|
"x-f5xc-example": "staging",
|
|
6363
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
6364
|
+
"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 \"\".",
|
|
6088
6365
|
"minLength": 0,
|
|
6089
6366
|
"maxLength": 6,
|
|
6090
6367
|
"x-f5xc-required-for": {
|
|
@@ -6095,9 +6372,10 @@
|
|
|
6095
6372
|
},
|
|
6096
6373
|
"x-original-maxLength": 1024,
|
|
6097
6374
|
"x-reconciled-from-discovery": true,
|
|
6098
|
-
"x-reconciled-at": "2026-01-
|
|
6375
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949754+00:00"
|
|
6099
6376
|
}
|
|
6100
6377
|
},
|
|
6378
|
+
"x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
|
|
6101
6379
|
"x-f5xc-minimum-configuration": {
|
|
6102
6380
|
"description": "Minimum configuration for schemaObjectReplaceMetaType",
|
|
6103
6381
|
"required_fields": [
|
|
@@ -6130,6 +6408,7 @@
|
|
|
6130
6408
|
"x-displayname": "Code",
|
|
6131
6409
|
"x-ves-example": "0",
|
|
6132
6410
|
"x-f5xc-example": "0",
|
|
6411
|
+
"x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
|
|
6133
6412
|
"minimum": 0,
|
|
6134
6413
|
"maximum": 2147483647,
|
|
6135
6414
|
"x-f5xc-required-for": {
|
|
@@ -6146,6 +6425,8 @@
|
|
|
6146
6425
|
"x-displayname": "Reason",
|
|
6147
6426
|
"x-ves-example": "Value",
|
|
6148
6427
|
"x-f5xc-example": "value",
|
|
6428
|
+
"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.",
|
|
6429
|
+
"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.",
|
|
6149
6430
|
"minLength": 0,
|
|
6150
6431
|
"maxLength": 43,
|
|
6151
6432
|
"x-f5xc-required-for": {
|
|
@@ -6156,7 +6437,7 @@
|
|
|
6156
6437
|
},
|
|
6157
6438
|
"x-original-maxLength": 1024,
|
|
6158
6439
|
"x-reconciled-from-discovery": true,
|
|
6159
|
-
"x-reconciled-at": "2026-01-
|
|
6440
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949760+00:00"
|
|
6160
6441
|
},
|
|
6161
6442
|
"status": {
|
|
6162
6443
|
"type": "string",
|
|
@@ -6165,6 +6446,7 @@
|
|
|
6165
6446
|
"x-displayname": "Status",
|
|
6166
6447
|
"x-ves-example": "Value",
|
|
6167
6448
|
"x-f5xc-example": "value",
|
|
6449
|
+
"x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
|
|
6168
6450
|
"minLength": 0,
|
|
6169
6451
|
"maxLength": 17,
|
|
6170
6452
|
"x-f5xc-required-for": {
|
|
@@ -6175,9 +6457,10 @@
|
|
|
6175
6457
|
},
|
|
6176
6458
|
"x-original-maxLength": 1024,
|
|
6177
6459
|
"x-reconciled-from-discovery": true,
|
|
6178
|
-
"x-reconciled-at": "2026-01-
|
|
6460
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949764+00:00"
|
|
6179
6461
|
}
|
|
6180
6462
|
},
|
|
6463
|
+
"x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
|
|
6181
6464
|
"x-f5xc-minimum-configuration": {
|
|
6182
6465
|
"description": "Minimum configuration for schemaStatusType",
|
|
6183
6466
|
"required_fields": [
|
|
@@ -6205,6 +6488,8 @@
|
|
|
6205
6488
|
"title": "Creation_timestamp.",
|
|
6206
6489
|
"format": "date-time",
|
|
6207
6490
|
"x-displayname": "Creation Timestamp.",
|
|
6491
|
+
"x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
|
|
6492
|
+
"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.",
|
|
6208
6493
|
"minLength": 0,
|
|
6209
6494
|
"maxLength": 1024,
|
|
6210
6495
|
"x-f5xc-required-for": {
|
|
@@ -6222,6 +6507,7 @@
|
|
|
6222
6507
|
"x-displayname": "Creator Class.",
|
|
6223
6508
|
"x-ves-example": "Prism",
|
|
6224
6509
|
"x-f5xc-example": "value",
|
|
6510
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
6225
6511
|
"minLength": 0,
|
|
6226
6512
|
"maxLength": 1024,
|
|
6227
6513
|
"x-f5xc-required-for": {
|
|
@@ -6239,6 +6525,7 @@
|
|
|
6239
6525
|
"x-displayname": "Creator ID.",
|
|
6240
6526
|
"x-ves-example": "Admin@example-corp.com.",
|
|
6241
6527
|
"x-f5xc-example": "value",
|
|
6528
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
6242
6529
|
"minLength": 0,
|
|
6243
6530
|
"maxLength": 1024,
|
|
6244
6531
|
"x-f5xc-required-for": {
|
|
@@ -6255,6 +6542,8 @@
|
|
|
6255
6542
|
"title": "Deletion_timestamp.",
|
|
6256
6543
|
"format": "date-time",
|
|
6257
6544
|
"x-displayname": "Deletion Timestamp.",
|
|
6545
|
+
"x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
|
|
6546
|
+
"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...",
|
|
6258
6547
|
"minLength": 0,
|
|
6259
6548
|
"maxLength": 1024,
|
|
6260
6549
|
"x-f5xc-required-for": {
|
|
@@ -6274,6 +6563,8 @@
|
|
|
6274
6563
|
"x-displayname": "Finalizers.",
|
|
6275
6564
|
"x-ves-example": "Value",
|
|
6276
6565
|
"x-f5xc-example": "value",
|
|
6566
|
+
"x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
|
|
6567
|
+
"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.",
|
|
6277
6568
|
"x-f5xc-required-for": {
|
|
6278
6569
|
"minimum_config": false,
|
|
6279
6570
|
"create": false,
|
|
@@ -6291,6 +6582,8 @@
|
|
|
6291
6582
|
"x-displayname": "Labels",
|
|
6292
6583
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
6293
6584
|
"x-f5xc-example": "'F5 XC/soft-deleted''true'",
|
|
6585
|
+
"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.",
|
|
6586
|
+
"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).",
|
|
6294
6587
|
"x-f5xc-required-for": {
|
|
6295
6588
|
"minimum_config": false,
|
|
6296
6589
|
"create": false,
|
|
@@ -6304,6 +6597,8 @@
|
|
|
6304
6597
|
"title": "Modification_timestamp.",
|
|
6305
6598
|
"format": "date-time",
|
|
6306
6599
|
"x-displayname": "Modification Timestamp.",
|
|
6600
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
6601
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
6307
6602
|
"minLength": 0,
|
|
6308
6603
|
"maxLength": 1024,
|
|
6309
6604
|
"x-f5xc-required-for": {
|
|
@@ -6322,6 +6617,8 @@
|
|
|
6322
6617
|
"x-displayname": "Object Index.",
|
|
6323
6618
|
"x-ves-example": "0",
|
|
6324
6619
|
"x-f5xc-example": "0",
|
|
6620
|
+
"x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
|
|
6621
|
+
"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.",
|
|
6325
6622
|
"minimum": 0,
|
|
6326
6623
|
"maximum": 2147483647,
|
|
6327
6624
|
"x-f5xc-required-for": {
|
|
@@ -6342,6 +6639,8 @@
|
|
|
6342
6639
|
"x-displayname": "Tenant",
|
|
6343
6640
|
"x-ves-example": "Example-corp.",
|
|
6344
6641
|
"x-f5xc-example": "example-corp",
|
|
6642
|
+
"x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
6643
|
+
"x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
6345
6644
|
"minLength": 0,
|
|
6346
6645
|
"maxLength": 18,
|
|
6347
6646
|
"x-f5xc-required-for": {
|
|
@@ -6353,7 +6652,7 @@
|
|
|
6353
6652
|
"x-field-mutability": "read-only",
|
|
6354
6653
|
"x-original-maxLength": 1024,
|
|
6355
6654
|
"x-reconciled-from-discovery": true,
|
|
6356
|
-
"x-reconciled-at": "2026-01-
|
|
6655
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949783+00:00"
|
|
6357
6656
|
},
|
|
6358
6657
|
"uid": {
|
|
6359
6658
|
"type": "string",
|
|
@@ -6362,6 +6661,8 @@
|
|
|
6362
6661
|
"x-displayname": "UID",
|
|
6363
6662
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
6364
6663
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
6664
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
|
|
6665
|
+
"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.",
|
|
6365
6666
|
"minLength": 0,
|
|
6366
6667
|
"maxLength": 36,
|
|
6367
6668
|
"x-f5xc-required-for": {
|
|
@@ -6374,9 +6675,11 @@
|
|
|
6374
6675
|
"x-original-maxLength": 1024,
|
|
6375
6676
|
"format": "uuid",
|
|
6376
6677
|
"x-reconciled-from-discovery": true,
|
|
6377
|
-
"x-reconciled-at": "2026-01-
|
|
6678
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949788+00:00"
|
|
6378
6679
|
}
|
|
6379
6680
|
},
|
|
6681
|
+
"x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
6682
|
+
"x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
6380
6683
|
"x-f5xc-minimum-configuration": {
|
|
6381
6684
|
"description": "Minimum configuration for schemaSystemObjectGetMetaType",
|
|
6382
6685
|
"required_fields": [
|
|
@@ -6424,7 +6727,7 @@
|
|
|
6424
6727
|
},
|
|
6425
6728
|
"x-original-maxLength": 1024,
|
|
6426
6729
|
"x-reconciled-from-discovery": true,
|
|
6427
|
-
"x-reconciled-at": "2026-01-
|
|
6730
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949793+00:00"
|
|
6428
6731
|
},
|
|
6429
6732
|
"name": {
|
|
6430
6733
|
"type": "string",
|
|
@@ -6433,6 +6736,8 @@
|
|
|
6433
6736
|
"x-displayname": "Name",
|
|
6434
6737
|
"x-ves-example": "Contactus-route.",
|
|
6435
6738
|
"x-f5xc-example": "contactus-route",
|
|
6739
|
+
"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.",
|
|
6740
|
+
"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.",
|
|
6436
6741
|
"minLength": 0,
|
|
6437
6742
|
"maxLength": 16,
|
|
6438
6743
|
"x-f5xc-required-for": {
|
|
@@ -6443,7 +6748,7 @@
|
|
|
6443
6748
|
},
|
|
6444
6749
|
"x-original-maxLength": 1024,
|
|
6445
6750
|
"x-reconciled-from-discovery": true,
|
|
6446
|
-
"x-reconciled-at": "2026-01-
|
|
6751
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949797+00:00"
|
|
6447
6752
|
},
|
|
6448
6753
|
"namespace": {
|
|
6449
6754
|
"type": "string",
|
|
@@ -6452,6 +6757,8 @@
|
|
|
6452
6757
|
"x-displayname": "Namespace",
|
|
6453
6758
|
"x-ves-example": "Ns1",
|
|
6454
6759
|
"x-f5xc-example": "ns1",
|
|
6760
|
+
"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.",
|
|
6761
|
+
"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.",
|
|
6455
6762
|
"minLength": 0,
|
|
6456
6763
|
"maxLength": 6,
|
|
6457
6764
|
"x-f5xc-required-for": {
|
|
@@ -6462,7 +6769,7 @@
|
|
|
6462
6769
|
},
|
|
6463
6770
|
"x-original-maxLength": 1024,
|
|
6464
6771
|
"x-reconciled-from-discovery": true,
|
|
6465
|
-
"x-reconciled-at": "2026-01-
|
|
6772
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949800+00:00"
|
|
6466
6773
|
},
|
|
6467
6774
|
"uid": {
|
|
6468
6775
|
"type": "string",
|
|
@@ -6483,9 +6790,10 @@
|
|
|
6483
6790
|
"x-original-maxLength": 1024,
|
|
6484
6791
|
"format": "uuid",
|
|
6485
6792
|
"x-reconciled-from-discovery": true,
|
|
6486
|
-
"x-reconciled-at": "2026-01-
|
|
6793
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949805+00:00"
|
|
6487
6794
|
}
|
|
6488
6795
|
},
|
|
6796
|
+
"x-f5xc-description-short": "ViewRefType represents a reference to a view.",
|
|
6489
6797
|
"x-f5xc-minimum-configuration": {
|
|
6490
6798
|
"description": "Minimum configuration for schemaViewRefType",
|
|
6491
6799
|
"required_fields": [
|
|
@@ -6547,6 +6855,8 @@
|
|
|
6547
6855
|
"default": "AWS_AP_NORTHEAST_1",
|
|
6548
6856
|
"x-displayname": "Location",
|
|
6549
6857
|
"x-ves-proto-enum": "ves.io.schema.views.bot_defense_app_infrastructure.Location",
|
|
6858
|
+
"x-f5xc-description-short": "Region location AWS_AP_NORTHEAST_1 AWS_AP_NORTHEAST_3 AWS_AP_SOUTH_1 AWS_AP_SOUTH_2 AWS_AP_SOUTHEAST_1 AWS_AP_SOUTHEAST_2 AWS_AP_SOUTHEAST_3...",
|
|
6859
|
+
"x-f5xc-description-medium": "Region location AWS_AP_NORTHEAST_1 AWS_AP_NORTHEAST_3 AWS_AP_SOUTH_1 AWS_AP_SOUTH_2 AWS_AP_SOUTHEAST_1 AWS_AP_SOUTHEAST_2 AWS_AP_SOUTHEAST_3 AWS_EU_CENTRAL_1 AWS_EU_NORTH_1 AWS_EU_WEST_1 AWS_ME_SOUTH_1 AWS_SA_EAST_1 AWS_US_EAST_1 AWS_US_EAST_2 AWS_US_WEST_1 AWS_US_WEST_2 GCP_ASIA_EAST_1...",
|
|
6550
6860
|
"x-f5xc-minimum-configuration": {
|
|
6551
6861
|
"description": "Minimum configuration for viewsbot_defense_app_infrastructureLocation",
|
|
6552
6862
|
"required_fields": [],
|
|
@@ -6563,6 +6873,7 @@
|
|
|
6563
6873
|
"title": "GET virtual host.",
|
|
6564
6874
|
"x-displayname": "GET Virtual Host.",
|
|
6565
6875
|
"x-ves-proto-message": "ves.io.schema.shape_bot_defense_instance.GetSpecType",
|
|
6876
|
+
"x-f5xc-description-short": "GET virtual host from a given namespace.",
|
|
6566
6877
|
"x-f5xc-minimum-configuration": {
|
|
6567
6878
|
"description": "Minimum configuration for schemashape_bot_defense_instanceGetSpecType",
|
|
6568
6879
|
"required_fields": [],
|
|
@@ -6588,6 +6899,7 @@
|
|
|
6588
6899
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
6589
6900
|
},
|
|
6590
6901
|
"x-displayname": "Deleted Referred Objects.",
|
|
6902
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6591
6903
|
"x-f5xc-required-for": {
|
|
6592
6904
|
"minimum_config": false,
|
|
6593
6905
|
"create": false,
|
|
@@ -6603,6 +6915,7 @@
|
|
|
6603
6915
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
6604
6916
|
},
|
|
6605
6917
|
"x-displayname": "Disabled Referred Objects.",
|
|
6918
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6606
6919
|
"x-f5xc-required-for": {
|
|
6607
6920
|
"minimum_config": false,
|
|
6608
6921
|
"create": false,
|
|
@@ -6621,6 +6934,7 @@
|
|
|
6621
6934
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
6622
6935
|
},
|
|
6623
6936
|
"x-displayname": "Referring Objects.",
|
|
6937
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
6624
6938
|
"x-f5xc-required-for": {
|
|
6625
6939
|
"minimum_config": false,
|
|
6626
6940
|
"create": false,
|
|
@@ -6663,6 +6977,8 @@
|
|
|
6663
6977
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
6664
6978
|
],
|
|
6665
6979
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
6980
|
+
"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...",
|
|
6981
|
+
"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_READ: x-displayName: \"GetSpecType format\" Response should be in format...",
|
|
6666
6982
|
"x-f5xc-minimum-configuration": {
|
|
6667
6983
|
"description": "Minimum configuration for shape_bot_defense_instanceGetResponseFormatCode",
|
|
6668
6984
|
"required_fields": [],
|
|
@@ -6688,6 +7004,7 @@
|
|
|
6688
7004
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
6689
7005
|
},
|
|
6690
7006
|
"x-displayname": "Errors",
|
|
7007
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
6691
7008
|
"x-f5xc-required-for": {
|
|
6692
7009
|
"minimum_config": false,
|
|
6693
7010
|
"create": false,
|
|
@@ -6703,6 +7020,8 @@
|
|
|
6703
7020
|
"$ref": "#/components/schemas/shape_bot_defense_instanceListResponseItem"
|
|
6704
7021
|
},
|
|
6705
7022
|
"x-displayname": "Items",
|
|
7023
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
7024
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
6706
7025
|
"x-f5xc-required-for": {
|
|
6707
7026
|
"minimum_config": false,
|
|
6708
7027
|
"create": false,
|
|
@@ -6736,6 +7055,8 @@
|
|
|
6736
7055
|
"description": "The set of annotations present on this shape_bot_defense_instance.",
|
|
6737
7056
|
"title": "Annotations.",
|
|
6738
7057
|
"x-displayname": "Annotations.",
|
|
7058
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7059
|
+
"x-f5xc-description-short": "The set of annotations present on this shape_bot_defense_instance.",
|
|
6739
7060
|
"x-f5xc-required-for": {
|
|
6740
7061
|
"minimum_config": false,
|
|
6741
7062
|
"create": false,
|
|
@@ -6748,6 +7069,7 @@
|
|
|
6748
7069
|
"description": "The description set for this shape_bot_defense_instance.",
|
|
6749
7070
|
"title": "Description.",
|
|
6750
7071
|
"x-displayname": "Description.",
|
|
7072
|
+
"x-f5xc-description-short": "The description set for this shape_bot_defense_instance.",
|
|
6751
7073
|
"minLength": 0,
|
|
6752
7074
|
"maxLength": 0,
|
|
6753
7075
|
"x-f5xc-required-for": {
|
|
@@ -6758,7 +7080,7 @@
|
|
|
6758
7080
|
},
|
|
6759
7081
|
"x-original-maxLength": 1024,
|
|
6760
7082
|
"x-reconciled-from-discovery": true,
|
|
6761
|
-
"x-reconciled-at": "2026-01-
|
|
7083
|
+
"x-reconciled-at": "2026-01-07T15:29:21.065598+00:00"
|
|
6762
7084
|
},
|
|
6763
7085
|
"disabled": {
|
|
6764
7086
|
"type": "boolean",
|
|
@@ -6766,6 +7088,8 @@
|
|
|
6766
7088
|
"title": "Disabled",
|
|
6767
7089
|
"format": "boolean",
|
|
6768
7090
|
"x-displayname": "Disabled",
|
|
7091
|
+
"x-f5xc-example": "True",
|
|
7092
|
+
"x-f5xc-description-short": "Value of true indicates shape_bot_defense_instance is administratively disabled.",
|
|
6769
7093
|
"x-f5xc-required-for": {
|
|
6770
7094
|
"minimum_config": false,
|
|
6771
7095
|
"create": false,
|
|
@@ -6781,6 +7105,8 @@
|
|
|
6781
7105
|
"description": "The set of labels present on this shape_bot_defense_instance.",
|
|
6782
7106
|
"title": "Labels",
|
|
6783
7107
|
"x-displayname": "Labels",
|
|
7108
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7109
|
+
"x-f5xc-description-short": "The set of labels present on this shape_bot_defense_instance.",
|
|
6784
7110
|
"x-f5xc-required-for": {
|
|
6785
7111
|
"minimum_config": false,
|
|
6786
7112
|
"create": false,
|
|
@@ -6798,6 +7124,7 @@
|
|
|
6798
7124
|
"x-displayname": "Name",
|
|
6799
7125
|
"x-ves-example": "Name",
|
|
6800
7126
|
"x-f5xc-example": "name",
|
|
7127
|
+
"x-f5xc-description-short": "The name of this shape_bot_defense_instance.",
|
|
6801
7128
|
"minLength": 0,
|
|
6802
7129
|
"maxLength": 16,
|
|
6803
7130
|
"x-f5xc-required-for": {
|
|
@@ -6808,7 +7135,7 @@
|
|
|
6808
7135
|
},
|
|
6809
7136
|
"x-original-maxLength": 1024,
|
|
6810
7137
|
"x-reconciled-from-discovery": true,
|
|
6811
|
-
"x-reconciled-at": "2026-01-
|
|
7138
|
+
"x-reconciled-at": "2026-01-07T15:29:21.065608+00:00"
|
|
6812
7139
|
},
|
|
6813
7140
|
"namespace": {
|
|
6814
7141
|
"type": "string",
|
|
@@ -6827,7 +7154,7 @@
|
|
|
6827
7154
|
},
|
|
6828
7155
|
"x-original-maxLength": 1024,
|
|
6829
7156
|
"x-reconciled-from-discovery": true,
|
|
6830
|
-
"x-reconciled-at": "2026-01-
|
|
7157
|
+
"x-reconciled-at": "2026-01-07T15:29:21.065612+00:00"
|
|
6831
7158
|
},
|
|
6832
7159
|
"owner_view": {
|
|
6833
7160
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -6853,7 +7180,7 @@
|
|
|
6853
7180
|
"x-field-mutability": "read-only",
|
|
6854
7181
|
"x-original-maxLength": 1024,
|
|
6855
7182
|
"x-reconciled-from-discovery": true,
|
|
6856
|
-
"x-reconciled-at": "2026-01-
|
|
7183
|
+
"x-reconciled-at": "2026-01-07T15:29:21.065618+00:00"
|
|
6857
7184
|
},
|
|
6858
7185
|
"uid": {
|
|
6859
7186
|
"type": "string",
|
|
@@ -6862,6 +7189,7 @@
|
|
|
6862
7189
|
"x-displayname": "UID",
|
|
6863
7190
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
6864
7191
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
7192
|
+
"x-f5xc-description-short": "The unique uid of this shape_bot_defense_instance.",
|
|
6865
7193
|
"minLength": 0,
|
|
6866
7194
|
"maxLength": 36,
|
|
6867
7195
|
"x-f5xc-required-for": {
|
|
@@ -6874,9 +7202,11 @@
|
|
|
6874
7202
|
"x-original-maxLength": 1024,
|
|
6875
7203
|
"format": "uuid",
|
|
6876
7204
|
"x-reconciled-from-discovery": true,
|
|
6877
|
-
"x-reconciled-at": "2026-01-
|
|
7205
|
+
"x-reconciled-at": "2026-01-07T15:29:21.065623+00:00"
|
|
6878
7206
|
}
|
|
6879
7207
|
},
|
|
7208
|
+
"x-f5xc-description-short": "By default a summary of shape_bot_defense_instance is returned in 'List'.",
|
|
7209
|
+
"x-f5xc-description-medium": "By default a summary of shape_bot_defense_instance is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
6880
7210
|
"x-f5xc-minimum-configuration": {
|
|
6881
7211
|
"description": "Minimum configuration for shape_bot_defense_instanceListResponseItem",
|
|
6882
7212
|
"required_fields": [
|
|
@@ -6912,6 +7242,8 @@
|
|
|
6912
7242
|
"description": "Hostname of the instance of the site that sent the status.",
|
|
6913
7243
|
"title": "Hostname",
|
|
6914
7244
|
"x-displayname": "Hostname",
|
|
7245
|
+
"x-f5xc-example": "example-resource",
|
|
7246
|
+
"x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
|
|
6915
7247
|
"minLength": 0,
|
|
6916
7248
|
"maxLength": 1024,
|
|
6917
7249
|
"x-f5xc-required-for": {
|
|
@@ -6943,6 +7275,8 @@
|
|
|
6943
7275
|
"x-displayname": "Reason",
|
|
6944
7276
|
"x-ves-example": "Value",
|
|
6945
7277
|
"x-f5xc-example": "value",
|
|
7278
|
+
"x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
7279
|
+
"x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
6946
7280
|
"minLength": 0,
|
|
6947
7281
|
"maxLength": 43,
|
|
6948
7282
|
"x-f5xc-required-for": {
|
|
@@ -6953,13 +7287,15 @@
|
|
|
6953
7287
|
},
|
|
6954
7288
|
"x-original-maxLength": 1024,
|
|
6955
7289
|
"x-reconciled-from-discovery": true,
|
|
6956
|
-
"x-reconciled-at": "2026-01-
|
|
7290
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138327+00:00"
|
|
6957
7291
|
},
|
|
6958
7292
|
"service_name": {
|
|
6959
7293
|
"type": "string",
|
|
6960
7294
|
"description": "Name of the service that sent the status.",
|
|
6961
7295
|
"title": "Service name.",
|
|
6962
7296
|
"x-displayname": "Service Name.",
|
|
7297
|
+
"x-f5xc-example": "example-resource",
|
|
7298
|
+
"x-f5xc-description-short": "Name of the service that sent the status.",
|
|
6963
7299
|
"minLength": 0,
|
|
6964
7300
|
"maxLength": 1024,
|
|
6965
7301
|
"x-f5xc-required-for": {
|
|
@@ -6982,6 +7318,8 @@
|
|
|
6982
7318
|
"x-validation-rules": {
|
|
6983
7319
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
|
|
6984
7320
|
},
|
|
7321
|
+
"x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
|
|
7322
|
+
"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...",
|
|
6985
7323
|
"minLength": 0,
|
|
6986
7324
|
"maxLength": 17,
|
|
6987
7325
|
"x-f5xc-required-for": {
|
|
@@ -6992,7 +7330,7 @@
|
|
|
6992
7330
|
},
|
|
6993
7331
|
"x-original-maxLength": 1024,
|
|
6994
7332
|
"x-reconciled-from-discovery": true,
|
|
6995
|
-
"x-reconciled-at": "2026-01-
|
|
7333
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138334+00:00"
|
|
6996
7334
|
},
|
|
6997
7335
|
"type": {
|
|
6998
7336
|
"type": "string",
|
|
@@ -7007,6 +7345,8 @@
|
|
|
7007
7345
|
"x-validation-rules": {
|
|
7008
7346
|
"ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
|
|
7009
7347
|
},
|
|
7348
|
+
"x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
|
|
7349
|
+
"x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
|
|
7010
7350
|
"minLength": 0,
|
|
7011
7351
|
"maxLength": 1024,
|
|
7012
7352
|
"x-f5xc-required-for": {
|
|
@@ -7017,6 +7357,8 @@
|
|
|
7017
7357
|
}
|
|
7018
7358
|
}
|
|
7019
7359
|
},
|
|
7360
|
+
"x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
|
|
7361
|
+
"x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
|
|
7020
7362
|
"x-f5xc-minimum-configuration": {
|
|
7021
7363
|
"description": "Minimum configuration for schemaConditionType",
|
|
7022
7364
|
"required_fields": [
|
|
@@ -7048,6 +7390,8 @@
|
|
|
7048
7390
|
"x-displayname": "Kind",
|
|
7049
7391
|
"x-ves-example": "Virtual_site.",
|
|
7050
7392
|
"x-f5xc-example": "virtual_site",
|
|
7393
|
+
"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\")",
|
|
7394
|
+
"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\").",
|
|
7051
7395
|
"minLength": 0,
|
|
7052
7396
|
"maxLength": 14,
|
|
7053
7397
|
"x-f5xc-required-for": {
|
|
@@ -7059,7 +7403,7 @@
|
|
|
7059
7403
|
"readOnly": true,
|
|
7060
7404
|
"x-original-maxLength": 1024,
|
|
7061
7405
|
"x-reconciled-from-discovery": true,
|
|
7062
|
-
"x-reconciled-at": "2026-01-
|
|
7406
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138392+00:00"
|
|
7063
7407
|
},
|
|
7064
7408
|
"name": {
|
|
7065
7409
|
"type": "string",
|
|
@@ -7068,6 +7412,8 @@
|
|
|
7068
7412
|
"x-displayname": "Name",
|
|
7069
7413
|
"x-ves-example": "Contactus-route.",
|
|
7070
7414
|
"x-f5xc-example": "contactus-route",
|
|
7415
|
+
"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.",
|
|
7416
|
+
"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.",
|
|
7071
7417
|
"minLength": 0,
|
|
7072
7418
|
"maxLength": 16,
|
|
7073
7419
|
"x-f5xc-required-for": {
|
|
@@ -7078,7 +7424,7 @@
|
|
|
7078
7424
|
},
|
|
7079
7425
|
"x-original-maxLength": 1024,
|
|
7080
7426
|
"x-reconciled-from-discovery": true,
|
|
7081
|
-
"x-reconciled-at": "2026-01-
|
|
7427
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138396+00:00"
|
|
7082
7428
|
},
|
|
7083
7429
|
"namespace": {
|
|
7084
7430
|
"type": "string",
|
|
@@ -7087,6 +7433,8 @@
|
|
|
7087
7433
|
"x-displayname": "Namespace",
|
|
7088
7434
|
"x-ves-example": "Ns1",
|
|
7089
7435
|
"x-f5xc-example": "ns1",
|
|
7436
|
+
"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.",
|
|
7437
|
+
"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.",
|
|
7090
7438
|
"minLength": 0,
|
|
7091
7439
|
"maxLength": 6,
|
|
7092
7440
|
"x-f5xc-required-for": {
|
|
@@ -7097,7 +7445,7 @@
|
|
|
7097
7445
|
},
|
|
7098
7446
|
"x-original-maxLength": 1024,
|
|
7099
7447
|
"x-reconciled-from-discovery": true,
|
|
7100
|
-
"x-reconciled-at": "2026-01-
|
|
7448
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138400+00:00"
|
|
7101
7449
|
},
|
|
7102
7450
|
"tenant": {
|
|
7103
7451
|
"type": "string",
|
|
@@ -7106,6 +7454,8 @@
|
|
|
7106
7454
|
"x-displayname": "Tenant",
|
|
7107
7455
|
"x-ves-example": "Example-corp.",
|
|
7108
7456
|
"x-f5xc-example": "example-corp",
|
|
7457
|
+
"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.",
|
|
7458
|
+
"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.",
|
|
7109
7459
|
"minLength": 0,
|
|
7110
7460
|
"maxLength": 18,
|
|
7111
7461
|
"x-f5xc-required-for": {
|
|
@@ -7118,7 +7468,7 @@
|
|
|
7118
7468
|
"x-field-mutability": "read-only",
|
|
7119
7469
|
"x-original-maxLength": 1024,
|
|
7120
7470
|
"x-reconciled-from-discovery": true,
|
|
7121
|
-
"x-reconciled-at": "2026-01-
|
|
7471
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138404+00:00"
|
|
7122
7472
|
},
|
|
7123
7473
|
"uid": {
|
|
7124
7474
|
"type": "string",
|
|
@@ -7127,6 +7477,8 @@
|
|
|
7127
7477
|
"x-displayname": "UID",
|
|
7128
7478
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
7129
7479
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
7480
|
+
"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.",
|
|
7481
|
+
"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.",
|
|
7130
7482
|
"minLength": 0,
|
|
7131
7483
|
"maxLength": 36,
|
|
7132
7484
|
"x-f5xc-required-for": {
|
|
@@ -7140,9 +7492,11 @@
|
|
|
7140
7492
|
"x-original-maxLength": 1024,
|
|
7141
7493
|
"format": "uuid",
|
|
7142
7494
|
"x-reconciled-from-discovery": true,
|
|
7143
|
-
"x-reconciled-at": "2026-01-
|
|
7495
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138411+00:00"
|
|
7144
7496
|
}
|
|
7145
7497
|
},
|
|
7498
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
7499
|
+
"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...",
|
|
7146
7500
|
"x-f5xc-minimum-configuration": {
|
|
7147
7501
|
"description": "Minimum configuration for schemaObjectRefType",
|
|
7148
7502
|
"required_fields": [
|
|
@@ -7172,6 +7526,8 @@
|
|
|
7172
7526
|
"title": "Creation_timestamp.",
|
|
7173
7527
|
"format": "date-time",
|
|
7174
7528
|
"x-displayname": "Creation Timestamp.",
|
|
7529
|
+
"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.",
|
|
7530
|
+
"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.",
|
|
7175
7531
|
"minLength": 0,
|
|
7176
7532
|
"maxLength": 1024,
|
|
7177
7533
|
"x-f5xc-required-for": {
|
|
@@ -7189,6 +7545,8 @@
|
|
|
7189
7545
|
"x-displayname": "Creator Class.",
|
|
7190
7546
|
"x-ves-example": "ver.re1.int.ves.I/O.",
|
|
7191
7547
|
"x-f5xc-example": "ver.re1.int.F5 XC",
|
|
7548
|
+
"x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
|
|
7549
|
+
"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.",
|
|
7192
7550
|
"minLength": 0,
|
|
7193
7551
|
"maxLength": 1024,
|
|
7194
7552
|
"x-f5xc-required-for": {
|
|
@@ -7206,6 +7564,8 @@
|
|
|
7206
7564
|
"x-displayname": "Creator ID.",
|
|
7207
7565
|
"x-ves-example": "Ver-instance-1.",
|
|
7208
7566
|
"x-f5xc-example": "ver-instance-1",
|
|
7567
|
+
"x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
|
|
7568
|
+
"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.",
|
|
7209
7569
|
"minLength": 0,
|
|
7210
7570
|
"maxLength": 1024,
|
|
7211
7571
|
"x-f5xc-required-for": {
|
|
@@ -7224,6 +7584,8 @@
|
|
|
7224
7584
|
"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)",
|
|
7225
7585
|
"title": "Status_id",
|
|
7226
7586
|
"x-displayname": "Status ID",
|
|
7587
|
+
"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...",
|
|
7588
|
+
"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).",
|
|
7227
7589
|
"minLength": 0,
|
|
7228
7590
|
"maxLength": 1024,
|
|
7229
7591
|
"x-f5xc-required-for": {
|
|
@@ -7241,6 +7603,7 @@
|
|
|
7241
7603
|
"x-displayname": "UID",
|
|
7242
7604
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
7243
7605
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
7606
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
|
|
7244
7607
|
"minLength": 0,
|
|
7245
7608
|
"maxLength": 36,
|
|
7246
7609
|
"x-f5xc-required-for": {
|
|
@@ -7253,13 +7616,14 @@
|
|
|
7253
7616
|
"x-original-maxLength": 1024,
|
|
7254
7617
|
"format": "uuid",
|
|
7255
7618
|
"x-reconciled-from-discovery": true,
|
|
7256
|
-
"x-reconciled-at": "2026-01-
|
|
7619
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138444+00:00"
|
|
7257
7620
|
},
|
|
7258
7621
|
"vtrp_id": {
|
|
7259
7622
|
"type": "string",
|
|
7260
7623
|
"description": "Origin of this status exchanged by VTRP.",
|
|
7261
7624
|
"title": "Vtrp_id",
|
|
7262
7625
|
"x-displayname": "VTRP ID",
|
|
7626
|
+
"x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
|
|
7263
7627
|
"minLength": 0,
|
|
7264
7628
|
"maxLength": 1024,
|
|
7265
7629
|
"x-f5xc-required-for": {
|
|
@@ -7276,6 +7640,7 @@
|
|
|
7276
7640
|
"title": "Vtrp_stale.",
|
|
7277
7641
|
"format": "boolean",
|
|
7278
7642
|
"x-displayname": "VTRP Stale.",
|
|
7643
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
7279
7644
|
"x-f5xc-required-for": {
|
|
7280
7645
|
"minimum_config": false,
|
|
7281
7646
|
"create": false,
|
|
@@ -7284,6 +7649,7 @@
|
|
|
7284
7649
|
}
|
|
7285
7650
|
}
|
|
7286
7651
|
},
|
|
7652
|
+
"x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
|
|
7287
7653
|
"x-f5xc-minimum-configuration": {
|
|
7288
7654
|
"description": "Minimum configuration for schemaStatusMetaType",
|
|
7289
7655
|
"required_fields": [
|
|
@@ -7314,6 +7680,8 @@
|
|
|
7314
7680
|
"default": "STATUS_DO_NOT_PUBLISH",
|
|
7315
7681
|
"x-displayname": "Status Publish Type.",
|
|
7316
7682
|
"x-ves-proto-enum": "ves.io.schema.StatusPublishType",
|
|
7683
|
+
"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.",
|
|
7684
|
+
"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.",
|
|
7317
7685
|
"x-f5xc-minimum-configuration": {
|
|
7318
7686
|
"description": "Minimum configuration for schemaStatusPublishType",
|
|
7319
7687
|
"required_fields": [],
|
|
@@ -7407,6 +7775,8 @@
|
|
|
7407
7775
|
"ves.io.schema.rules.repeated.max_items": "1",
|
|
7408
7776
|
"ves.io.schema.rules.repeated.min_items": "1"
|
|
7409
7777
|
},
|
|
7778
|
+
"x-f5xc-description-short": "APIKey needs a reference to an existing TPM category object TPM category is used for grouping customer owned APIKeys and manage them as one entity...",
|
|
7779
|
+
"x-f5xc-description-medium": "APIKey needs a reference to an existing TPM category object TPM category is used for grouping customer owned APIKeys and manage them as one entity Required: YES.",
|
|
7410
7780
|
"x-f5xc-required-for": {
|
|
7411
7781
|
"minimum_config": false,
|
|
7412
7782
|
"create": false,
|
|
@@ -7422,6 +7792,7 @@
|
|
|
7422
7792
|
"x-displayname": "Need mTLS",
|
|
7423
7793
|
"x-ves-example": "True",
|
|
7424
7794
|
"x-f5xc-example": "true",
|
|
7795
|
+
"x-f5xc-description-short": "Is mTLS required when using this APIKey?",
|
|
7425
7796
|
"x-f5xc-required-for": {
|
|
7426
7797
|
"minimum_config": false,
|
|
7427
7798
|
"create": false,
|
|
@@ -7430,6 +7801,8 @@
|
|
|
7430
7801
|
}
|
|
7431
7802
|
}
|
|
7432
7803
|
},
|
|
7804
|
+
"x-f5xc-description-short": "APIKey object when successfully created returns actual APIKey bytes which is used by the users to call in to TPM provisioning API.",
|
|
7805
|
+
"x-f5xc-description-medium": "APIKey object when successfully created returns actual APIKey bytes which is used by the users to call in to TPM provisioning API.",
|
|
7433
7806
|
"x-f5xc-minimum-configuration": {
|
|
7434
7807
|
"description": "Minimum configuration for tpm_api_keyCreateSpecType",
|
|
7435
7808
|
"required_fields": [
|
|
@@ -7461,6 +7834,7 @@
|
|
|
7461
7834
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
7462
7835
|
},
|
|
7463
7836
|
"x-displayname": "Deleted Referred Objects.",
|
|
7837
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
7464
7838
|
"x-f5xc-required-for": {
|
|
7465
7839
|
"minimum_config": false,
|
|
7466
7840
|
"create": false,
|
|
@@ -7476,6 +7850,7 @@
|
|
|
7476
7850
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
7477
7851
|
},
|
|
7478
7852
|
"x-displayname": "Disabled Referred Objects.",
|
|
7853
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
7479
7854
|
"x-f5xc-required-for": {
|
|
7480
7855
|
"minimum_config": false,
|
|
7481
7856
|
"create": false,
|
|
@@ -7494,6 +7869,7 @@
|
|
|
7494
7869
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
7495
7870
|
},
|
|
7496
7871
|
"x-displayname": "Referring Objects.",
|
|
7872
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
7497
7873
|
"x-f5xc-required-for": {
|
|
7498
7874
|
"minimum_config": false,
|
|
7499
7875
|
"create": false,
|
|
@@ -7515,6 +7891,8 @@
|
|
|
7515
7891
|
"$ref": "#/components/schemas/tpm_api_keyStatusObject"
|
|
7516
7892
|
},
|
|
7517
7893
|
"x-displayname": "Status",
|
|
7894
|
+
"x-f5xc-example": "active",
|
|
7895
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
7518
7896
|
"x-f5xc-required-for": {
|
|
7519
7897
|
"minimum_config": false,
|
|
7520
7898
|
"create": false,
|
|
@@ -7524,7 +7902,7 @@
|
|
|
7524
7902
|
"maxLength": 17,
|
|
7525
7903
|
"minLength": 17,
|
|
7526
7904
|
"x-reconciled-from-discovery": true,
|
|
7527
|
-
"x-reconciled-at": "2026-01-
|
|
7905
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138535+00:00"
|
|
7528
7906
|
},
|
|
7529
7907
|
"system_metadata": {
|
|
7530
7908
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -7564,6 +7942,8 @@
|
|
|
7564
7942
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
7565
7943
|
],
|
|
7566
7944
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
7945
|
+
"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...",
|
|
7946
|
+
"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...",
|
|
7567
7947
|
"x-f5xc-minimum-configuration": {
|
|
7568
7948
|
"description": "Minimum configuration for tpm_api_keyGetResponseFormatCode",
|
|
7569
7949
|
"required_fields": [],
|
|
@@ -7602,6 +7982,8 @@
|
|
|
7602
7982
|
"ves.io.schema.rules.repeated.max_items": "1",
|
|
7603
7983
|
"ves.io.schema.rules.repeated.min_items": "1"
|
|
7604
7984
|
},
|
|
7985
|
+
"x-f5xc-description-short": "APIKey needs a reference to an existing TPM category object TPM category is used for grouping customer owned APIKeys and manage them as one entity...",
|
|
7986
|
+
"x-f5xc-description-medium": "APIKey needs a reference to an existing TPM category object TPM category is used for grouping customer owned APIKeys and manage them as one entity Required: YES.",
|
|
7605
7987
|
"x-f5xc-required-for": {
|
|
7606
7988
|
"minimum_config": false,
|
|
7607
7989
|
"create": false,
|
|
@@ -7617,6 +7999,7 @@
|
|
|
7617
7999
|
"x-displayname": "Is_disabled.",
|
|
7618
8000
|
"x-ves-example": "True",
|
|
7619
8001
|
"x-f5xc-example": "true",
|
|
8002
|
+
"x-f5xc-description-short": "If true that indicates that this APIKey is disabled.",
|
|
7620
8003
|
"x-f5xc-required-for": {
|
|
7621
8004
|
"minimum_config": false,
|
|
7622
8005
|
"create": false,
|
|
@@ -7632,6 +8015,7 @@
|
|
|
7632
8015
|
"x-displayname": "Need mTLS",
|
|
7633
8016
|
"x-ves-example": "True",
|
|
7634
8017
|
"x-f5xc-example": "true",
|
|
8018
|
+
"x-f5xc-description-short": "Is mTLS required when using this APIKey?",
|
|
7635
8019
|
"x-f5xc-required-for": {
|
|
7636
8020
|
"minimum_config": false,
|
|
7637
8021
|
"create": false,
|
|
@@ -7646,6 +8030,8 @@
|
|
|
7646
8030
|
"x-displayname": "Revoke_reason.",
|
|
7647
8031
|
"x-ves-example": "Value",
|
|
7648
8032
|
"x-f5xc-example": "value",
|
|
8033
|
+
"x-f5xc-description-short": "If the APIKey is revoked then this value stores date and time after which the revocation is enforced.",
|
|
8034
|
+
"x-f5xc-description-medium": "If the APIKey is revoked then this value stores date and time after which the revocation is enforced.",
|
|
7649
8035
|
"minLength": 0,
|
|
7650
8036
|
"maxLength": 1024,
|
|
7651
8037
|
"x-f5xc-required-for": {
|
|
@@ -7661,6 +8047,8 @@
|
|
|
7661
8047
|
"title": "Revocation timestamp.",
|
|
7662
8048
|
"format": "date-time",
|
|
7663
8049
|
"x-displayname": "Revoked_timestamp.",
|
|
8050
|
+
"x-f5xc-description-short": "If the APIKey is revoked then this value stores date and time after which the revocation is enforced.",
|
|
8051
|
+
"x-f5xc-description-medium": "If the APIKey is revoked then this value stores date and time after which the revocation is enforced.",
|
|
7664
8052
|
"minLength": 0,
|
|
7665
8053
|
"maxLength": 1024,
|
|
7666
8054
|
"x-f5xc-required-for": {
|
|
@@ -7702,6 +8090,7 @@
|
|
|
7702
8090
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
7703
8091
|
},
|
|
7704
8092
|
"x-displayname": "Errors",
|
|
8093
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
7705
8094
|
"x-f5xc-required-for": {
|
|
7706
8095
|
"minimum_config": false,
|
|
7707
8096
|
"create": false,
|
|
@@ -7717,6 +8106,8 @@
|
|
|
7717
8106
|
"$ref": "#/components/schemas/tpm_api_keyListResponseItem"
|
|
7718
8107
|
},
|
|
7719
8108
|
"x-displayname": "Items",
|
|
8109
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
8110
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
7720
8111
|
"x-f5xc-required-for": {
|
|
7721
8112
|
"minimum_config": false,
|
|
7722
8113
|
"create": false,
|
|
@@ -7750,6 +8141,8 @@
|
|
|
7750
8141
|
"description": "The set of annotations present on this tpm_api_key.",
|
|
7751
8142
|
"title": "Annotations.",
|
|
7752
8143
|
"x-displayname": "Annotations.",
|
|
8144
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
8145
|
+
"x-f5xc-description-short": "The set of annotations present on this tpm_api_key.",
|
|
7753
8146
|
"x-f5xc-required-for": {
|
|
7754
8147
|
"minimum_config": false,
|
|
7755
8148
|
"create": false,
|
|
@@ -7762,6 +8155,7 @@
|
|
|
7762
8155
|
"description": "The description set for this tpm_api_key.",
|
|
7763
8156
|
"title": "Description.",
|
|
7764
8157
|
"x-displayname": "Description.",
|
|
8158
|
+
"x-f5xc-description-short": "The description set for this tpm_api_key.",
|
|
7765
8159
|
"minLength": 0,
|
|
7766
8160
|
"maxLength": 0,
|
|
7767
8161
|
"x-f5xc-required-for": {
|
|
@@ -7772,7 +8166,7 @@
|
|
|
7772
8166
|
},
|
|
7773
8167
|
"x-original-maxLength": 1024,
|
|
7774
8168
|
"x-reconciled-from-discovery": true,
|
|
7775
|
-
"x-reconciled-at": "2026-01-
|
|
8169
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138556+00:00"
|
|
7776
8170
|
},
|
|
7777
8171
|
"disabled": {
|
|
7778
8172
|
"type": "boolean",
|
|
@@ -7780,6 +8174,8 @@
|
|
|
7780
8174
|
"title": "Disabled",
|
|
7781
8175
|
"format": "boolean",
|
|
7782
8176
|
"x-displayname": "Disabled",
|
|
8177
|
+
"x-f5xc-example": "True",
|
|
8178
|
+
"x-f5xc-description-short": "Value of true indicates tpm_api_key is administratively disabled.",
|
|
7783
8179
|
"x-f5xc-required-for": {
|
|
7784
8180
|
"minimum_config": false,
|
|
7785
8181
|
"create": false,
|
|
@@ -7795,6 +8191,8 @@
|
|
|
7795
8191
|
"description": "The set of labels present on this tpm_api_key.",
|
|
7796
8192
|
"title": "Labels",
|
|
7797
8193
|
"x-displayname": "Labels",
|
|
8194
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
8195
|
+
"x-f5xc-description-short": "The set of labels present on this tpm_api_key.",
|
|
7798
8196
|
"x-f5xc-required-for": {
|
|
7799
8197
|
"minimum_config": false,
|
|
7800
8198
|
"create": false,
|
|
@@ -7822,7 +8220,7 @@
|
|
|
7822
8220
|
},
|
|
7823
8221
|
"x-original-maxLength": 1024,
|
|
7824
8222
|
"x-reconciled-from-discovery": true,
|
|
7825
|
-
"x-reconciled-at": "2026-01-
|
|
8223
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138565+00:00"
|
|
7826
8224
|
},
|
|
7827
8225
|
"namespace": {
|
|
7828
8226
|
"type": "string",
|
|
@@ -7841,7 +8239,7 @@
|
|
|
7841
8239
|
},
|
|
7842
8240
|
"x-original-maxLength": 1024,
|
|
7843
8241
|
"x-reconciled-from-discovery": true,
|
|
7844
|
-
"x-reconciled-at": "2026-01-
|
|
8242
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138570+00:00"
|
|
7845
8243
|
},
|
|
7846
8244
|
"owner_view": {
|
|
7847
8245
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -7854,6 +8252,7 @@
|
|
|
7854
8252
|
"$ref": "#/components/schemas/tpm_api_keyStatusObject"
|
|
7855
8253
|
},
|
|
7856
8254
|
"x-displayname": "Status",
|
|
8255
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
7857
8256
|
"x-f5xc-required-for": {
|
|
7858
8257
|
"minimum_config": false,
|
|
7859
8258
|
"create": false,
|
|
@@ -7882,7 +8281,7 @@
|
|
|
7882
8281
|
"x-field-mutability": "read-only",
|
|
7883
8282
|
"x-original-maxLength": 1024,
|
|
7884
8283
|
"x-reconciled-from-discovery": true,
|
|
7885
|
-
"x-reconciled-at": "2026-01-
|
|
8284
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138577+00:00"
|
|
7886
8285
|
},
|
|
7887
8286
|
"uid": {
|
|
7888
8287
|
"type": "string",
|
|
@@ -7903,9 +8302,11 @@
|
|
|
7903
8302
|
"x-original-maxLength": 1024,
|
|
7904
8303
|
"format": "uuid",
|
|
7905
8304
|
"x-reconciled-from-discovery": true,
|
|
7906
|
-
"x-reconciled-at": "2026-01-
|
|
8305
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138582+00:00"
|
|
7907
8306
|
}
|
|
7908
8307
|
},
|
|
8308
|
+
"x-f5xc-description-short": "By default a summary of tpm_api_key is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
8309
|
+
"x-f5xc-description-medium": "By default a summary of tpm_api_key is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
7909
8310
|
"x-f5xc-minimum-configuration": {
|
|
7910
8311
|
"description": "Minimum configuration for tpm_api_keyListResponseItem",
|
|
7911
8312
|
"required_fields": [
|
|
@@ -7985,6 +8386,7 @@
|
|
|
7985
8386
|
"x-displayname": "Is_disabled.",
|
|
7986
8387
|
"x-ves-example": "True",
|
|
7987
8388
|
"x-f5xc-example": "true",
|
|
8389
|
+
"x-f5xc-description-short": "If true that indicates that this APIKey is disabled.",
|
|
7988
8390
|
"x-f5xc-required-for": {
|
|
7989
8391
|
"minimum_config": false,
|
|
7990
8392
|
"create": false,
|
|
@@ -7999,6 +8401,8 @@
|
|
|
7999
8401
|
"x-displayname": "Revoke_reason.",
|
|
8000
8402
|
"x-ves-example": "Value",
|
|
8001
8403
|
"x-f5xc-example": "value",
|
|
8404
|
+
"x-f5xc-description-short": "If the APIKey is revoked then this value stores date and time after which the revocation is enforced.",
|
|
8405
|
+
"x-f5xc-description-medium": "If the APIKey is revoked then this value stores date and time after which the revocation is enforced.",
|
|
8002
8406
|
"minLength": 0,
|
|
8003
8407
|
"maxLength": 1024,
|
|
8004
8408
|
"x-f5xc-required-for": {
|
|
@@ -8014,6 +8418,8 @@
|
|
|
8014
8418
|
"title": "Timestamp when this apikey was revoked.",
|
|
8015
8419
|
"format": "date-time",
|
|
8016
8420
|
"x-displayname": "Revoked_timestamp.",
|
|
8421
|
+
"x-f5xc-description-short": "If the APIKey is revoked then this value stores date and time after which the revocation is enforced.",
|
|
8422
|
+
"x-f5xc-description-medium": "If the APIKey is revoked then this value stores date and time after which the revocation is enforced.",
|
|
8017
8423
|
"minLength": 0,
|
|
8018
8424
|
"maxLength": 1024,
|
|
8019
8425
|
"x-f5xc-required-for": {
|
|
@@ -8024,6 +8430,8 @@
|
|
|
8024
8430
|
}
|
|
8025
8431
|
}
|
|
8026
8432
|
},
|
|
8433
|
+
"x-f5xc-description-short": "Replace a APIKey object's revocation or enable/disable status. A revoked APIKey is not considered disabled.",
|
|
8434
|
+
"x-f5xc-description-medium": "Replace a APIKey object's revocation or enable/disable status. A revoked APIKey is not considered disabled. Certificates minted using disabled APIKeys are rejected during system bring-up/verification stage, whereas certificates minted using revoked APIKeys are only rejected if they were minted...",
|
|
8027
8435
|
"x-f5xc-minimum-configuration": {
|
|
8028
8436
|
"description": "Minimum configuration for tpm_api_keyReplaceSpecType",
|
|
8029
8437
|
"required_fields": [
|
|
@@ -8054,6 +8462,7 @@
|
|
|
8054
8462
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
8055
8463
|
},
|
|
8056
8464
|
"x-displayname": "Conditions.",
|
|
8465
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
8057
8466
|
"x-f5xc-required-for": {
|
|
8058
8467
|
"minimum_config": false,
|
|
8059
8468
|
"create": false,
|
|
@@ -8080,6 +8489,7 @@
|
|
|
8080
8489
|
}
|
|
8081
8490
|
}
|
|
8082
8491
|
},
|
|
8492
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
8083
8493
|
"x-f5xc-minimum-configuration": {
|
|
8084
8494
|
"description": "Minimum configuration for tpm_api_keyStatusObject",
|
|
8085
8495
|
"required_fields": [
|
|
@@ -8166,6 +8576,8 @@
|
|
|
8166
8576
|
"x-displayname": "List of allowed TPM EK Certificates.",
|
|
8167
8577
|
"x-ves-example": "Value",
|
|
8168
8578
|
"x-f5xc-example": "value",
|
|
8579
|
+
"x-f5xc-description-short": "TPM manufacturer is typically identified by its EK certificate.",
|
|
8580
|
+
"x-f5xc-description-medium": "TPM manufacturer is typically identified by its EK certificate. TPMAdmin can configure a allow-list of EK certificates for a given category When a TPM provision request is called, TPMAuthority verifies that EK certificate provided in provision matches one the EK certificate on this allow-list...",
|
|
8169
8581
|
"x-f5xc-required-for": {
|
|
8170
8582
|
"minimum_config": false,
|
|
8171
8583
|
"create": false,
|
|
@@ -8202,6 +8614,7 @@
|
|
|
8202
8614
|
}
|
|
8203
8615
|
}
|
|
8204
8616
|
},
|
|
8617
|
+
"x-f5xc-description-short": "Create a Category object, which is a grouping of APIKeys used for TPM provisioning.",
|
|
8205
8618
|
"x-f5xc-minimum-configuration": {
|
|
8206
8619
|
"description": "Minimum configuration for tpm_categoryCreateSpecType",
|
|
8207
8620
|
"required_fields": [
|
|
@@ -8233,6 +8646,7 @@
|
|
|
8233
8646
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
8234
8647
|
},
|
|
8235
8648
|
"x-displayname": "Deleted Referred Objects.",
|
|
8649
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
8236
8650
|
"x-f5xc-required-for": {
|
|
8237
8651
|
"minimum_config": false,
|
|
8238
8652
|
"create": false,
|
|
@@ -8248,6 +8662,7 @@
|
|
|
8248
8662
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
8249
8663
|
},
|
|
8250
8664
|
"x-displayname": "Disabled Referred Objects.",
|
|
8665
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
8251
8666
|
"x-f5xc-required-for": {
|
|
8252
8667
|
"minimum_config": false,
|
|
8253
8668
|
"create": false,
|
|
@@ -8266,6 +8681,7 @@
|
|
|
8266
8681
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
8267
8682
|
},
|
|
8268
8683
|
"x-displayname": "Referring Objects.",
|
|
8684
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
8269
8685
|
"x-f5xc-required-for": {
|
|
8270
8686
|
"minimum_config": false,
|
|
8271
8687
|
"create": false,
|
|
@@ -8287,6 +8703,8 @@
|
|
|
8287
8703
|
"$ref": "#/components/schemas/tpm_categoryStatusObject"
|
|
8288
8704
|
},
|
|
8289
8705
|
"x-displayname": "Status",
|
|
8706
|
+
"x-f5xc-example": "active",
|
|
8707
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
8290
8708
|
"x-f5xc-required-for": {
|
|
8291
8709
|
"minimum_config": false,
|
|
8292
8710
|
"create": false,
|
|
@@ -8296,7 +8714,7 @@
|
|
|
8296
8714
|
"maxLength": 17,
|
|
8297
8715
|
"minLength": 17,
|
|
8298
8716
|
"x-reconciled-from-discovery": true,
|
|
8299
|
-
"x-reconciled-at": "2026-01-
|
|
8717
|
+
"x-reconciled-at": "2026-01-07T15:29:30.553246+00:00"
|
|
8300
8718
|
},
|
|
8301
8719
|
"system_metadata": {
|
|
8302
8720
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -8336,6 +8754,8 @@
|
|
|
8336
8754
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
8337
8755
|
],
|
|
8338
8756
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
8757
|
+
"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...",
|
|
8758
|
+
"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...",
|
|
8339
8759
|
"x-f5xc-minimum-configuration": {
|
|
8340
8760
|
"description": "Minimum configuration for tpm_categoryGetResponseFormatCode",
|
|
8341
8761
|
"required_fields": [],
|
|
@@ -8360,6 +8780,7 @@
|
|
|
8360
8780
|
"x-displayname": "AK Sub CA Certificate.",
|
|
8361
8781
|
"x-ves-example": "Value",
|
|
8362
8782
|
"x-f5xc-example": "value",
|
|
8783
|
+
"x-f5xc-description-short": "PEM formatted Sub CA certificate which will sign the TPM AK Certificate for this category.",
|
|
8363
8784
|
"minLength": 0,
|
|
8364
8785
|
"maxLength": 1024,
|
|
8365
8786
|
"x-f5xc-required-for": {
|
|
@@ -8376,6 +8797,7 @@
|
|
|
8376
8797
|
"x-displayname": "AK_SUB_CA_NAME.",
|
|
8377
8798
|
"x-ves-example": "Value",
|
|
8378
8799
|
"x-f5xc-example": "value",
|
|
8800
|
+
"x-f5xc-description-short": "Name of the Sub CA which will sign the TPM AK Certificate for this category.",
|
|
8379
8801
|
"minLength": 0,
|
|
8380
8802
|
"maxLength": 1024,
|
|
8381
8803
|
"x-f5xc-required-for": {
|
|
@@ -8392,6 +8814,7 @@
|
|
|
8392
8814
|
"x-displayname": "Client certificate.",
|
|
8393
8815
|
"x-ves-example": "Value",
|
|
8394
8816
|
"x-f5xc-example": "value",
|
|
8817
|
+
"x-f5xc-description-short": "PEM formatted Client certificate for mTLS.",
|
|
8395
8818
|
"minLength": 0,
|
|
8396
8819
|
"maxLength": 1024,
|
|
8397
8820
|
"x-f5xc-required-for": {
|
|
@@ -8408,6 +8831,7 @@
|
|
|
8408
8831
|
"x-displayname": "ClientKey",
|
|
8409
8832
|
"x-ves-example": "Value",
|
|
8410
8833
|
"x-f5xc-example": "value",
|
|
8834
|
+
"x-f5xc-description-short": "Client Key for mTLS to be used with ClientCert.",
|
|
8411
8835
|
"minLength": 0,
|
|
8412
8836
|
"maxLength": 1024,
|
|
8413
8837
|
"x-f5xc-required-for": {
|
|
@@ -8427,6 +8851,8 @@
|
|
|
8427
8851
|
"x-displayname": "List of allowed TPM EK Certificates.",
|
|
8428
8852
|
"x-ves-example": "Value",
|
|
8429
8853
|
"x-f5xc-example": "value",
|
|
8854
|
+
"x-f5xc-description-short": "TPM manufacturer is typically identified by its EK certificate.",
|
|
8855
|
+
"x-f5xc-description-medium": "TPM manufacturer is typically identified by its EK certificate. TPMAdmin can configure a allow-list of EK certificates for a given category When a TPM provision request is called, TPMAuthority verifies that EK certificate provided in provision matches one the EK certificate on this allow-list...",
|
|
8430
8856
|
"x-f5xc-required-for": {
|
|
8431
8857
|
"minimum_config": false,
|
|
8432
8858
|
"create": false,
|
|
@@ -8495,6 +8921,7 @@
|
|
|
8495
8921
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
8496
8922
|
},
|
|
8497
8923
|
"x-displayname": "Errors",
|
|
8924
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
8498
8925
|
"x-f5xc-required-for": {
|
|
8499
8926
|
"minimum_config": false,
|
|
8500
8927
|
"create": false,
|
|
@@ -8510,6 +8937,8 @@
|
|
|
8510
8937
|
"$ref": "#/components/schemas/tpm_categoryListResponseItem"
|
|
8511
8938
|
},
|
|
8512
8939
|
"x-displayname": "Items",
|
|
8940
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
8941
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
8513
8942
|
"x-f5xc-required-for": {
|
|
8514
8943
|
"minimum_config": false,
|
|
8515
8944
|
"create": false,
|
|
@@ -8543,6 +8972,8 @@
|
|
|
8543
8972
|
"description": "The set of annotations present on this tpm_category.",
|
|
8544
8973
|
"title": "Annotations.",
|
|
8545
8974
|
"x-displayname": "Annotations.",
|
|
8975
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
8976
|
+
"x-f5xc-description-short": "The set of annotations present on this tpm_category.",
|
|
8546
8977
|
"x-f5xc-required-for": {
|
|
8547
8978
|
"minimum_config": false,
|
|
8548
8979
|
"create": false,
|
|
@@ -8555,6 +8986,7 @@
|
|
|
8555
8986
|
"description": "The description set for this tpm_category.",
|
|
8556
8987
|
"title": "Description.",
|
|
8557
8988
|
"x-displayname": "Description.",
|
|
8989
|
+
"x-f5xc-description-short": "The description set for this tpm_category.",
|
|
8558
8990
|
"minLength": 0,
|
|
8559
8991
|
"maxLength": 0,
|
|
8560
8992
|
"x-f5xc-required-for": {
|
|
@@ -8565,7 +8997,7 @@
|
|
|
8565
8997
|
},
|
|
8566
8998
|
"x-original-maxLength": 1024,
|
|
8567
8999
|
"x-reconciled-from-discovery": true,
|
|
8568
|
-
"x-reconciled-at": "2026-01-
|
|
9000
|
+
"x-reconciled-at": "2026-01-07T15:29:30.553267+00:00"
|
|
8569
9001
|
},
|
|
8570
9002
|
"disabled": {
|
|
8571
9003
|
"type": "boolean",
|
|
@@ -8573,6 +9005,8 @@
|
|
|
8573
9005
|
"title": "Disabled",
|
|
8574
9006
|
"format": "boolean",
|
|
8575
9007
|
"x-displayname": "Disabled",
|
|
9008
|
+
"x-f5xc-example": "True",
|
|
9009
|
+
"x-f5xc-description-short": "Value of true indicates tpm_category is administratively disabled.",
|
|
8576
9010
|
"x-f5xc-required-for": {
|
|
8577
9011
|
"minimum_config": false,
|
|
8578
9012
|
"create": false,
|
|
@@ -8588,6 +9022,8 @@
|
|
|
8588
9022
|
"description": "The set of labels present on this tpm_category.",
|
|
8589
9023
|
"title": "Labels",
|
|
8590
9024
|
"x-displayname": "Labels",
|
|
9025
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
9026
|
+
"x-f5xc-description-short": "The set of labels present on this tpm_category.",
|
|
8591
9027
|
"x-f5xc-required-for": {
|
|
8592
9028
|
"minimum_config": false,
|
|
8593
9029
|
"create": false,
|
|
@@ -8615,7 +9051,7 @@
|
|
|
8615
9051
|
},
|
|
8616
9052
|
"x-original-maxLength": 1024,
|
|
8617
9053
|
"x-reconciled-from-discovery": true,
|
|
8618
|
-
"x-reconciled-at": "2026-01-
|
|
9054
|
+
"x-reconciled-at": "2026-01-07T15:29:30.553277+00:00"
|
|
8619
9055
|
},
|
|
8620
9056
|
"namespace": {
|
|
8621
9057
|
"type": "string",
|
|
@@ -8634,7 +9070,7 @@
|
|
|
8634
9070
|
},
|
|
8635
9071
|
"x-original-maxLength": 1024,
|
|
8636
9072
|
"x-reconciled-from-discovery": true,
|
|
8637
|
-
"x-reconciled-at": "2026-01-
|
|
9073
|
+
"x-reconciled-at": "2026-01-07T15:29:30.553281+00:00"
|
|
8638
9074
|
},
|
|
8639
9075
|
"owner_view": {
|
|
8640
9076
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -8647,6 +9083,7 @@
|
|
|
8647
9083
|
"$ref": "#/components/schemas/tpm_categoryStatusObject"
|
|
8648
9084
|
},
|
|
8649
9085
|
"x-displayname": "Status",
|
|
9086
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
8650
9087
|
"x-f5xc-required-for": {
|
|
8651
9088
|
"minimum_config": false,
|
|
8652
9089
|
"create": false,
|
|
@@ -8675,7 +9112,7 @@
|
|
|
8675
9112
|
"x-field-mutability": "read-only",
|
|
8676
9113
|
"x-original-maxLength": 1024,
|
|
8677
9114
|
"x-reconciled-from-discovery": true,
|
|
8678
|
-
"x-reconciled-at": "2026-01-
|
|
9115
|
+
"x-reconciled-at": "2026-01-07T15:29:30.553289+00:00"
|
|
8679
9116
|
},
|
|
8680
9117
|
"uid": {
|
|
8681
9118
|
"type": "string",
|
|
@@ -8696,9 +9133,11 @@
|
|
|
8696
9133
|
"x-original-maxLength": 1024,
|
|
8697
9134
|
"format": "uuid",
|
|
8698
9135
|
"x-reconciled-from-discovery": true,
|
|
8699
|
-
"x-reconciled-at": "2026-01-
|
|
9136
|
+
"x-reconciled-at": "2026-01-07T15:29:30.553294+00:00"
|
|
8700
9137
|
}
|
|
8701
9138
|
},
|
|
9139
|
+
"x-f5xc-description-short": "By default a summary of tpm_category is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
9140
|
+
"x-f5xc-description-medium": "By default a summary of tpm_category is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
8702
9141
|
"x-f5xc-minimum-configuration": {
|
|
8703
9142
|
"description": "Minimum configuration for tpm_categoryListResponseItem",
|
|
8704
9143
|
"required_fields": [
|
|
@@ -8780,6 +9219,8 @@
|
|
|
8780
9219
|
"x-displayname": "List of allowed TPM EK Certificates.",
|
|
8781
9220
|
"x-ves-example": "Value",
|
|
8782
9221
|
"x-f5xc-example": "value",
|
|
9222
|
+
"x-f5xc-description-short": "TPM manufacturer is typically identified by its EK certificate.",
|
|
9223
|
+
"x-f5xc-description-medium": "TPM manufacturer is typically identified by its EK certificate. TPMAdmin can configure a allow-list of EK certificates for a given category When a TPM provision request is called, TPMAuthority verifies that EK certificate provided in provision matches one the EK certificate on this allow-list...",
|
|
8783
9224
|
"x-f5xc-required-for": {
|
|
8784
9225
|
"minimum_config": false,
|
|
8785
9226
|
"create": false,
|
|
@@ -8788,6 +9229,7 @@
|
|
|
8788
9229
|
}
|
|
8789
9230
|
}
|
|
8790
9231
|
},
|
|
9232
|
+
"x-f5xc-description-short": "Replace a Category object's Allow list of TPM EK Certificates.",
|
|
8791
9233
|
"x-f5xc-minimum-configuration": {
|
|
8792
9234
|
"description": "Minimum configuration for tpm_categoryReplaceSpecType",
|
|
8793
9235
|
"required_fields": [
|
|
@@ -8816,6 +9258,7 @@
|
|
|
8816
9258
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
8817
9259
|
},
|
|
8818
9260
|
"x-displayname": "Conditions.",
|
|
9261
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
8819
9262
|
"x-f5xc-required-for": {
|
|
8820
9263
|
"minimum_config": false,
|
|
8821
9264
|
"create": false,
|
|
@@ -8842,6 +9285,7 @@
|
|
|
8842
9285
|
}
|
|
8843
9286
|
}
|
|
8844
9287
|
},
|
|
9288
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
8845
9289
|
"x-f5xc-minimum-configuration": {
|
|
8846
9290
|
"description": "Minimum configuration for tpm_categoryStatusObject",
|
|
8847
9291
|
"required_fields": [
|
|
@@ -8945,6 +9389,7 @@
|
|
|
8945
9389
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
8946
9390
|
},
|
|
8947
9391
|
"x-displayname": "Deleted Referred Objects.",
|
|
9392
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
8948
9393
|
"x-f5xc-required-for": {
|
|
8949
9394
|
"minimum_config": false,
|
|
8950
9395
|
"create": false,
|
|
@@ -8960,6 +9405,7 @@
|
|
|
8960
9405
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
8961
9406
|
},
|
|
8962
9407
|
"x-displayname": "Disabled Referred Objects.",
|
|
9408
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
8963
9409
|
"x-f5xc-required-for": {
|
|
8964
9410
|
"minimum_config": false,
|
|
8965
9411
|
"create": false,
|
|
@@ -8978,6 +9424,7 @@
|
|
|
8978
9424
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
8979
9425
|
},
|
|
8980
9426
|
"x-displayname": "Referring Objects.",
|
|
9427
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
8981
9428
|
"x-f5xc-required-for": {
|
|
8982
9429
|
"minimum_config": false,
|
|
8983
9430
|
"create": false,
|
|
@@ -8996,6 +9443,8 @@
|
|
|
8996
9443
|
"$ref": "#/components/schemas/tpm_managerStatusObject"
|
|
8997
9444
|
},
|
|
8998
9445
|
"x-displayname": "Status",
|
|
9446
|
+
"x-f5xc-example": "active",
|
|
9447
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
8999
9448
|
"x-f5xc-required-for": {
|
|
9000
9449
|
"minimum_config": false,
|
|
9001
9450
|
"create": false,
|
|
@@ -9005,7 +9454,7 @@
|
|
|
9005
9454
|
"maxLength": 17,
|
|
9006
9455
|
"minLength": 17,
|
|
9007
9456
|
"x-reconciled-from-discovery": true,
|
|
9008
|
-
"x-reconciled-at": "2026-01-
|
|
9457
|
+
"x-reconciled-at": "2026-01-07T15:29:30.934209+00:00"
|
|
9009
9458
|
},
|
|
9010
9459
|
"system_metadata": {
|
|
9011
9460
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -9043,6 +9492,8 @@
|
|
|
9043
9492
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
9044
9493
|
],
|
|
9045
9494
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
9495
|
+
"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...",
|
|
9496
|
+
"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...",
|
|
9046
9497
|
"x-f5xc-minimum-configuration": {
|
|
9047
9498
|
"description": "Minimum configuration for tpm_managerGetResponseFormatCode",
|
|
9048
9499
|
"required_fields": [],
|
|
@@ -9083,6 +9534,8 @@
|
|
|
9083
9534
|
"x-displayname": "AK(Attestation Key) Root CA Name.",
|
|
9084
9535
|
"x-ves-example": "Value",
|
|
9085
9536
|
"x-f5xc-example": "value",
|
|
9537
|
+
"x-f5xc-description-short": "Name of the Root CA under which there will a SubCA per category, the SubCA then will be used to mint the TPM AK Certificate AK ROOT CA | AK SUB CA...",
|
|
9538
|
+
"x-f5xc-description-medium": "Name of the Root CA under which there will a SubCA per category, the SubCA then will be used to mint the TPM AK Certificate AK ROOT CA | AK SUB CA (this is per tpm category) | TPM AK Certificate.",
|
|
9086
9539
|
"minLength": 0,
|
|
9087
9540
|
"maxLength": 1024,
|
|
9088
9541
|
"x-f5xc-required-for": {
|
|
@@ -9121,6 +9574,7 @@
|
|
|
9121
9574
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
9122
9575
|
},
|
|
9123
9576
|
"x-displayname": "Errors",
|
|
9577
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
9124
9578
|
"x-f5xc-required-for": {
|
|
9125
9579
|
"minimum_config": false,
|
|
9126
9580
|
"create": false,
|
|
@@ -9136,6 +9590,8 @@
|
|
|
9136
9590
|
"$ref": "#/components/schemas/tpm_managerListResponseItem"
|
|
9137
9591
|
},
|
|
9138
9592
|
"x-displayname": "Items",
|
|
9593
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
9594
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
9139
9595
|
"x-f5xc-required-for": {
|
|
9140
9596
|
"minimum_config": false,
|
|
9141
9597
|
"create": false,
|
|
@@ -9169,6 +9625,8 @@
|
|
|
9169
9625
|
"description": "The set of annotations present on this tpm_manager.",
|
|
9170
9626
|
"title": "Annotations.",
|
|
9171
9627
|
"x-displayname": "Annotations.",
|
|
9628
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
9629
|
+
"x-f5xc-description-short": "The set of annotations present on this tpm_manager.",
|
|
9172
9630
|
"x-f5xc-required-for": {
|
|
9173
9631
|
"minimum_config": false,
|
|
9174
9632
|
"create": false,
|
|
@@ -9181,6 +9639,7 @@
|
|
|
9181
9639
|
"description": "The description set for this tpm_manager.",
|
|
9182
9640
|
"title": "Description.",
|
|
9183
9641
|
"x-displayname": "Description.",
|
|
9642
|
+
"x-f5xc-description-short": "The description set for this tpm_manager.",
|
|
9184
9643
|
"minLength": 0,
|
|
9185
9644
|
"maxLength": 0,
|
|
9186
9645
|
"x-f5xc-required-for": {
|
|
@@ -9191,7 +9650,7 @@
|
|
|
9191
9650
|
},
|
|
9192
9651
|
"x-original-maxLength": 1024,
|
|
9193
9652
|
"x-reconciled-from-discovery": true,
|
|
9194
|
-
"x-reconciled-at": "2026-01-
|
|
9653
|
+
"x-reconciled-at": "2026-01-07T15:29:30.934224+00:00"
|
|
9195
9654
|
},
|
|
9196
9655
|
"disabled": {
|
|
9197
9656
|
"type": "boolean",
|
|
@@ -9199,6 +9658,8 @@
|
|
|
9199
9658
|
"title": "Disabled",
|
|
9200
9659
|
"format": "boolean",
|
|
9201
9660
|
"x-displayname": "Disabled",
|
|
9661
|
+
"x-f5xc-example": "True",
|
|
9662
|
+
"x-f5xc-description-short": "Value of true indicates tpm_manager is administratively disabled.",
|
|
9202
9663
|
"x-f5xc-required-for": {
|
|
9203
9664
|
"minimum_config": false,
|
|
9204
9665
|
"create": false,
|
|
@@ -9214,6 +9675,8 @@
|
|
|
9214
9675
|
"description": "The set of labels present on this tpm_manager.",
|
|
9215
9676
|
"title": "Labels",
|
|
9216
9677
|
"x-displayname": "Labels",
|
|
9678
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
9679
|
+
"x-f5xc-description-short": "The set of labels present on this tpm_manager.",
|
|
9217
9680
|
"x-f5xc-required-for": {
|
|
9218
9681
|
"minimum_config": false,
|
|
9219
9682
|
"create": false,
|
|
@@ -9241,7 +9704,7 @@
|
|
|
9241
9704
|
},
|
|
9242
9705
|
"x-original-maxLength": 1024,
|
|
9243
9706
|
"x-reconciled-from-discovery": true,
|
|
9244
|
-
"x-reconciled-at": "2026-01-
|
|
9707
|
+
"x-reconciled-at": "2026-01-07T15:29:30.934234+00:00"
|
|
9245
9708
|
},
|
|
9246
9709
|
"namespace": {
|
|
9247
9710
|
"type": "string",
|
|
@@ -9260,7 +9723,7 @@
|
|
|
9260
9723
|
},
|
|
9261
9724
|
"x-original-maxLength": 1024,
|
|
9262
9725
|
"x-reconciled-from-discovery": true,
|
|
9263
|
-
"x-reconciled-at": "2026-01-
|
|
9726
|
+
"x-reconciled-at": "2026-01-07T15:29:30.934238+00:00"
|
|
9264
9727
|
},
|
|
9265
9728
|
"owner_view": {
|
|
9266
9729
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -9273,6 +9736,7 @@
|
|
|
9273
9736
|
"$ref": "#/components/schemas/tpm_managerStatusObject"
|
|
9274
9737
|
},
|
|
9275
9738
|
"x-displayname": "Status",
|
|
9739
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
9276
9740
|
"x-f5xc-required-for": {
|
|
9277
9741
|
"minimum_config": false,
|
|
9278
9742
|
"create": false,
|
|
@@ -9301,7 +9765,7 @@
|
|
|
9301
9765
|
"x-field-mutability": "read-only",
|
|
9302
9766
|
"x-original-maxLength": 1024,
|
|
9303
9767
|
"x-reconciled-from-discovery": true,
|
|
9304
|
-
"x-reconciled-at": "2026-01-
|
|
9768
|
+
"x-reconciled-at": "2026-01-07T15:29:30.934246+00:00"
|
|
9305
9769
|
},
|
|
9306
9770
|
"uid": {
|
|
9307
9771
|
"type": "string",
|
|
@@ -9322,9 +9786,11 @@
|
|
|
9322
9786
|
"x-original-maxLength": 1024,
|
|
9323
9787
|
"format": "uuid",
|
|
9324
9788
|
"x-reconciled-from-discovery": true,
|
|
9325
|
-
"x-reconciled-at": "2026-01-
|
|
9789
|
+
"x-reconciled-at": "2026-01-07T15:29:30.934251+00:00"
|
|
9326
9790
|
}
|
|
9327
9791
|
},
|
|
9792
|
+
"x-f5xc-description-short": "By default a summary of tpm_manager is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
9793
|
+
"x-f5xc-description-medium": "By default a summary of tpm_manager is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
9328
9794
|
"x-f5xc-minimum-configuration": {
|
|
9329
9795
|
"description": "Minimum configuration for tpm_managerListResponseItem",
|
|
9330
9796
|
"required_fields": [
|
|
@@ -9365,6 +9831,7 @@
|
|
|
9365
9831
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
9366
9832
|
},
|
|
9367
9833
|
"x-displayname": "Conditions.",
|
|
9834
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
9368
9835
|
"x-f5xc-required-for": {
|
|
9369
9836
|
"minimum_config": false,
|
|
9370
9837
|
"create": false,
|
|
@@ -9391,6 +9858,7 @@
|
|
|
9391
9858
|
}
|
|
9392
9859
|
}
|
|
9393
9860
|
},
|
|
9861
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
9394
9862
|
"x-f5xc-minimum-configuration": {
|
|
9395
9863
|
"description": "Minimum configuration for tpm_managerStatusObject",
|
|
9396
9864
|
"required_fields": [
|
|
@@ -9436,7 +9904,7 @@
|
|
|
9436
9904
|
},
|
|
9437
9905
|
"x-original-maxLength": 1024,
|
|
9438
9906
|
"x-reconciled-from-discovery": true,
|
|
9439
|
-
"x-reconciled-at": "2026-01-
|
|
9907
|
+
"x-reconciled-at": "2026-01-07T15:29:31.188629+00:00"
|
|
9440
9908
|
},
|
|
9441
9909
|
"serial": {
|
|
9442
9910
|
"type": "string",
|
|
@@ -9508,9 +9976,10 @@
|
|
|
9508
9976
|
},
|
|
9509
9977
|
"x-original-maxLength": 1024,
|
|
9510
9978
|
"x-reconciled-from-discovery": true,
|
|
9511
|
-
"x-reconciled-at": "2026-01-
|
|
9979
|
+
"x-reconciled-at": "2026-01-07T15:29:31.188640+00:00"
|
|
9512
9980
|
}
|
|
9513
9981
|
},
|
|
9982
|
+
"x-f5xc-description-short": "DeviceInfo defines device parameters like Serial-Number to include in the TPM provisioning data.",
|
|
9514
9983
|
"x-f5xc-minimum-configuration": {
|
|
9515
9984
|
"description": "Minimum configuration for tpm_provisionDeviceInfo",
|
|
9516
9985
|
"required_fields": [
|
|
@@ -9547,6 +10016,7 @@
|
|
|
9547
10016
|
"x-validation-rules": {
|
|
9548
10017
|
"ves.io.schema.rules.message.required": "true"
|
|
9549
10018
|
},
|
|
10019
|
+
"x-f5xc-description-short": "API Key allocated to TPM Provisioning (manufacturing) user Required: YES.",
|
|
9550
10020
|
"minLength": 0,
|
|
9551
10021
|
"maxLength": 1024,
|
|
9552
10022
|
"x-f5xc-required-for": {
|
|
@@ -9560,6 +10030,8 @@
|
|
|
9560
10030
|
"$ref": "#/components/schemas/tpm_provisionDeviceInfo"
|
|
9561
10031
|
}
|
|
9562
10032
|
},
|
|
10033
|
+
"x-f5xc-description-short": "PreauthRequest defines parameters required for pre-flight auth checks before using the TPM Provisioning API key.",
|
|
10034
|
+
"x-f5xc-description-medium": "PreauthRequest defines parameters required for pre-flight auth checks before using the TPM Provisioning API key.",
|
|
9563
10035
|
"x-f5xc-minimum-configuration": {
|
|
9564
10036
|
"description": "Minimum configuration for tpm_provisionPreauthRequest",
|
|
9565
10037
|
"required_fields": [
|
|
@@ -9584,6 +10056,7 @@
|
|
|
9584
10056
|
"$ref": "#/components/schemas/tpm_provisionPreauthResponseStatus"
|
|
9585
10057
|
}
|
|
9586
10058
|
},
|
|
10059
|
+
"x-f5xc-description-short": "PreauthResponse defines the preauthorization response.",
|
|
9587
10060
|
"x-f5xc-minimum-configuration": {
|
|
9588
10061
|
"description": "Minimum configuration for tpm_provisionPreauthResponse",
|
|
9589
10062
|
"required_fields": [
|
|
@@ -9608,6 +10081,8 @@
|
|
|
9608
10081
|
"default": "PREAUTH_RSP_SUCCESS",
|
|
9609
10082
|
"x-displayname": "Preauth Response Status.",
|
|
9610
10083
|
"x-ves-proto-enum": "ves.io.schema.tpm_provision.PreauthResponseStatus",
|
|
10084
|
+
"x-f5xc-description-short": "Status code OPTIONS for Preauthorization Response - PREAUTH_RSP_SUCCESS: Preauth status - success, both api_key and device_info are valid ...",
|
|
10085
|
+
"x-f5xc-description-medium": "Status code OPTIONS for Preauthorization Response - PREAUTH_RSP_SUCCESS: Preauth status - success, both api_key and device_info are valid - PREAUTH_RSP_INVALID_API_KEY: Preauth status - api_key is invalid - PREAUTH_RSP_INVALID_DEVICE_INFO: Preauth status - device info is invalid.",
|
|
9611
10086
|
"x-f5xc-minimum-configuration": {
|
|
9612
10087
|
"description": "Minimum configuration for tpm_provisionPreauthResponseStatus",
|
|
9613
10088
|
"required_fields": [],
|
|
@@ -9639,6 +10114,7 @@
|
|
|
9639
10114
|
"x-validation-rules": {
|
|
9640
10115
|
"ves.io.schema.rules.message.required": "true"
|
|
9641
10116
|
},
|
|
10117
|
+
"x-f5xc-description-short": "TPM AK Public Key in DER format Required: YES.",
|
|
9642
10118
|
"minLength": 0,
|
|
9643
10119
|
"maxLength": 1024,
|
|
9644
10120
|
"x-f5xc-required-for": {
|
|
@@ -9662,6 +10138,7 @@
|
|
|
9662
10138
|
"x-validation-rules": {
|
|
9663
10139
|
"ves.io.schema.rules.message.required": "true"
|
|
9664
10140
|
},
|
|
10141
|
+
"x-f5xc-description-short": "API Key allocated to TPM Provisioning (manufacturing) user Required: YES.",
|
|
9665
10142
|
"minLength": 0,
|
|
9666
10143
|
"maxLength": 1024,
|
|
9667
10144
|
"x-f5xc-required-for": {
|
|
@@ -9685,6 +10162,7 @@
|
|
|
9685
10162
|
"x-validation-rules": {
|
|
9686
10163
|
"ves.io.schema.rules.message.required": "true"
|
|
9687
10164
|
},
|
|
10165
|
+
"x-f5xc-description-short": "Signing request from the manufacturing plant for device TPM provisioning Required: YES.",
|
|
9688
10166
|
"minLength": 0,
|
|
9689
10167
|
"maxLength": 1024,
|
|
9690
10168
|
"x-f5xc-required-for": {
|
|
@@ -9711,6 +10189,7 @@
|
|
|
9711
10189
|
"x-validation-rules": {
|
|
9712
10190
|
"ves.io.schema.rules.message.required": "true"
|
|
9713
10191
|
},
|
|
10192
|
+
"x-f5xc-description-short": "TPM EK Certificate in DER format Required: YES.",
|
|
9714
10193
|
"minLength": 0,
|
|
9715
10194
|
"maxLength": 1024,
|
|
9716
10195
|
"x-f5xc-required-for": {
|
|
@@ -9734,6 +10213,7 @@
|
|
|
9734
10213
|
"x-validation-rules": {
|
|
9735
10214
|
"ves.io.schema.rules.message.required": "true"
|
|
9736
10215
|
},
|
|
10216
|
+
"x-f5xc-description-short": "TPM EK Public Key in DER format Required: YES.",
|
|
9737
10217
|
"minLength": 0,
|
|
9738
10218
|
"maxLength": 1024,
|
|
9739
10219
|
"x-f5xc-required-for": {
|
|
@@ -9744,6 +10224,7 @@
|
|
|
9744
10224
|
}
|
|
9745
10225
|
}
|
|
9746
10226
|
},
|
|
10227
|
+
"x-f5xc-description-short": "ProvisionReq defines parameters required for TPM Provisioning Request API.",
|
|
9747
10228
|
"x-f5xc-minimum-configuration": {
|
|
9748
10229
|
"description": "Minimum configuration for tpm_provisionProvisionRequest",
|
|
9749
10230
|
"required_fields": [
|
|
@@ -9774,6 +10255,7 @@
|
|
|
9774
10255
|
"x-displayname": "TPM Credential Bundle.",
|
|
9775
10256
|
"x-ves-example": "Value",
|
|
9776
10257
|
"x-f5xc-example": "value",
|
|
10258
|
+
"x-f5xc-description-short": "TPM Credential bundle used to decrypt the encrypted AK certificate.",
|
|
9777
10259
|
"minLength": 0,
|
|
9778
10260
|
"maxLength": 1024,
|
|
9779
10261
|
"x-f5xc-required-for": {
|
|
@@ -9790,6 +10272,7 @@
|
|
|
9790
10272
|
"x-displayname": "TPM AK Certificate.",
|
|
9791
10273
|
"x-ves-example": "Value",
|
|
9792
10274
|
"x-f5xc-example": "value",
|
|
10275
|
+
"x-f5xc-description-short": "AK Certificate signed by the TPM CA and encrypted according to TPM 2.0 spec.",
|
|
9793
10276
|
"minLength": 0,
|
|
9794
10277
|
"maxLength": 1024,
|
|
9795
10278
|
"x-f5xc-required-for": {
|
|
@@ -9806,6 +10289,7 @@
|
|
|
9806
10289
|
"x-displayname": "TPM Encryption Nonce.",
|
|
9807
10290
|
"x-ves-example": "Value",
|
|
9808
10291
|
"x-f5xc-example": "value",
|
|
10292
|
+
"x-f5xc-description-short": "Nonce used to encrypt the AK certificate.",
|
|
9809
10293
|
"minLength": 0,
|
|
9810
10294
|
"maxLength": 1024,
|
|
9811
10295
|
"x-f5xc-required-for": {
|