@robinmordasiewicz/f5xc-api-mcp 2.0.13-2601051957 → 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/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 +111 -25
- package/specs/domains/ai_services.json +114 -35
- package/specs/domains/api.json +1082 -177
- package/specs/domains/authentication.json +205 -45
- package/specs/domains/bigip.json +593 -101
- package/specs/domains/billing_and_usage.json +440 -82
- package/specs/domains/blindfold.json +713 -110
- package/specs/domains/bot_and_threat_defense.json +359 -65
- package/specs/domains/cdn.json +2131 -194
- package/specs/domains/ce_management.json +9110 -15844
- package/specs/domains/certificates.json +362 -75
- package/specs/domains/cloud_infrastructure.json +802 -119
- package/specs/domains/container_services.json +613 -95
- package/specs/domains/data_and_privacy_security.json +364 -66
- package/specs/domains/data_intelligence.json +324 -63
- package/specs/domains/ddos.json +766 -159
- package/specs/domains/dns.json +820 -161
- package/specs/domains/managed_kubernetes.json +455 -85
- package/specs/domains/marketplace.json +670 -104
- package/specs/domains/network.json +1620 -238
- package/specs/domains/network_security.json +1401 -191
- package/specs/domains/nginx_one.json +326 -62
- package/specs/domains/object_storage.json +49 -15
- package/specs/domains/observability.json +999 -147
- package/specs/domains/rate_limiting.json +300 -55
- package/specs/domains/secops_and_incident_response.json +189 -36
- package/specs/domains/service_mesh.json +955 -124
- package/specs/domains/shape.json +2150 -397
- package/specs/domains/sites.json +3830 -364
- package/specs/domains/statistics.json +2117 -235
- package/specs/domains/support.json +602 -108
- package/specs/domains/telemetry_and_insights.json +753 -79
- package/specs/domains/tenant_and_identity.json +1874 -308
- package/specs/domains/threat_campaign.json +637 -71
- package/specs/domains/users.json +278 -66
- package/specs/domains/virtual.json +2803 -260
- package/specs/domains/vpm_and_node_management.json +3 -1
- package/specs/domains/waf.json +1125 -148
- package/specs/index.json +24 -24
|
@@ -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"
|
|
@@ -4651,6 +4651,8 @@
|
|
|
4651
4651
|
"default": "US",
|
|
4652
4652
|
"x-displayname": "Bot Defense Advanced Region.",
|
|
4653
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.",
|
|
4654
4656
|
"x-f5xc-minimum-configuration": {
|
|
4655
4657
|
"description": "Minimum configuration for bot_defense_app_infrastructureBotDefenseAdvancedRegion",
|
|
4656
4658
|
"required_fields": [],
|
|
@@ -4737,6 +4739,7 @@
|
|
|
4737
4739
|
"$ref": "#/components/schemas/bot_defense_app_infrastructureTrafficType"
|
|
4738
4740
|
}
|
|
4739
4741
|
},
|
|
4742
|
+
"x-f5xc-description-short": "Creates Bot Defense App Infrastructure in a given namespace.",
|
|
4740
4743
|
"x-f5xc-minimum-configuration": {
|
|
4741
4744
|
"description": "Minimum configuration for bot_defense_app_infrastructureCreateSpecType",
|
|
4742
4745
|
"required_fields": [
|
|
@@ -4765,6 +4768,7 @@
|
|
|
4765
4768
|
"title": "Fail_if_referred.",
|
|
4766
4769
|
"format": "boolean",
|
|
4767
4770
|
"x-displayname": "Fail-If-Referred.",
|
|
4771
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
4768
4772
|
"x-f5xc-required-for": {
|
|
4769
4773
|
"minimum_config": false,
|
|
4770
4774
|
"create": false,
|
|
@@ -4789,7 +4793,7 @@
|
|
|
4789
4793
|
},
|
|
4790
4794
|
"x-original-maxLength": 1024,
|
|
4791
4795
|
"x-reconciled-from-discovery": true,
|
|
4792
|
-
"x-reconciled-at": "2026-01-
|
|
4796
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949574+00:00"
|
|
4793
4797
|
},
|
|
4794
4798
|
"namespace": {
|
|
4795
4799
|
"type": "string",
|
|
@@ -4798,6 +4802,7 @@
|
|
|
4798
4802
|
"x-displayname": "Namespace",
|
|
4799
4803
|
"x-ves-example": "Ns1",
|
|
4800
4804
|
"x-f5xc-example": "ns1",
|
|
4805
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
4801
4806
|
"minLength": 0,
|
|
4802
4807
|
"maxLength": 6,
|
|
4803
4808
|
"x-f5xc-required-for": {
|
|
@@ -4808,7 +4813,7 @@
|
|
|
4808
4813
|
},
|
|
4809
4814
|
"x-original-maxLength": 1024,
|
|
4810
4815
|
"x-reconciled-from-discovery": true,
|
|
4811
|
-
"x-reconciled-at": "2026-01-
|
|
4816
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949580+00:00"
|
|
4812
4817
|
}
|
|
4813
4818
|
},
|
|
4814
4819
|
"x-f5xc-minimum-configuration": {
|
|
@@ -4885,6 +4890,7 @@
|
|
|
4885
4890
|
"default": "PRODUCTION",
|
|
4886
4891
|
"x-displayname": "Environment Type.",
|
|
4887
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.",
|
|
4888
4894
|
"x-f5xc-minimum-configuration": {
|
|
4889
4895
|
"description": "Minimum configuration for bot_defense_app_infrastructureEnvironmentType",
|
|
4890
4896
|
"required_fields": [],
|
|
@@ -4913,6 +4919,7 @@
|
|
|
4913
4919
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
4914
4920
|
},
|
|
4915
4921
|
"x-displayname": "Deleted Referred Objects.",
|
|
4922
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
4916
4923
|
"x-f5xc-required-for": {
|
|
4917
4924
|
"minimum_config": false,
|
|
4918
4925
|
"create": false,
|
|
@@ -4928,6 +4935,7 @@
|
|
|
4928
4935
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
4929
4936
|
},
|
|
4930
4937
|
"x-displayname": "Disabled Referred Objects.",
|
|
4938
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
4931
4939
|
"x-f5xc-required-for": {
|
|
4932
4940
|
"minimum_config": false,
|
|
4933
4941
|
"create": false,
|
|
@@ -4946,6 +4954,7 @@
|
|
|
4946
4954
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
4947
4955
|
},
|
|
4948
4956
|
"x-displayname": "Referring Objects.",
|
|
4957
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
4949
4958
|
"x-f5xc-required-for": {
|
|
4950
4959
|
"minimum_config": false,
|
|
4951
4960
|
"create": false,
|
|
@@ -4995,6 +5004,8 @@
|
|
|
4995
5004
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
4996
5005
|
],
|
|
4997
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...",
|
|
4998
5009
|
"x-f5xc-minimum-configuration": {
|
|
4999
5010
|
"description": "Minimum configuration for bot_defense_app_infrastructureGetResponseFormatCode",
|
|
5000
5011
|
"required_fields": [],
|
|
@@ -5026,6 +5037,7 @@
|
|
|
5026
5037
|
"$ref": "#/components/schemas/bot_defense_app_infrastructureTrafficType"
|
|
5027
5038
|
}
|
|
5028
5039
|
},
|
|
5040
|
+
"x-f5xc-description-short": "GET Bot Defense App Infrastructure from a given namespace.",
|
|
5029
5041
|
"x-f5xc-minimum-configuration": {
|
|
5030
5042
|
"description": "Minimum configuration for bot_defense_app_infrastructureGetSpecType",
|
|
5031
5043
|
"required_fields": [
|
|
@@ -5168,6 +5180,8 @@
|
|
|
5168
5180
|
"x-validation-rules": {
|
|
5169
5181
|
"ves.io.schema.rules.string.hostname": "true"
|
|
5170
5182
|
},
|
|
5183
|
+
"x-f5xc-example": "example-resource",
|
|
5184
|
+
"x-f5xc-description-short": "Exclusive with [ip_address] Ingress Host Name.",
|
|
5171
5185
|
"minLength": 0,
|
|
5172
5186
|
"maxLength": 1024,
|
|
5173
5187
|
"x-f5xc-required-for": {
|
|
@@ -5189,6 +5203,7 @@
|
|
|
5189
5203
|
"ves.io.schema.rules.string.ip": "true"
|
|
5190
5204
|
},
|
|
5191
5205
|
"x-f5xc-example": "192.0.2.1",
|
|
5206
|
+
"x-f5xc-description-short": "Exclusive with [host_name] Ingress IP Address.",
|
|
5192
5207
|
"minLength": 0,
|
|
5193
5208
|
"maxLength": 1024,
|
|
5194
5209
|
"x-f5xc-required-for": {
|
|
@@ -5231,6 +5246,7 @@
|
|
|
5231
5246
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
5232
5247
|
},
|
|
5233
5248
|
"x-displayname": "Errors",
|
|
5249
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
5234
5250
|
"x-f5xc-required-for": {
|
|
5235
5251
|
"minimum_config": false,
|
|
5236
5252
|
"create": false,
|
|
@@ -5246,6 +5262,8 @@
|
|
|
5246
5262
|
"$ref": "#/components/schemas/bot_defense_app_infrastructureListResponseItem"
|
|
5247
5263
|
},
|
|
5248
5264
|
"x-displayname": "Items",
|
|
5265
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
5266
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
5249
5267
|
"x-f5xc-required-for": {
|
|
5250
5268
|
"minimum_config": false,
|
|
5251
5269
|
"create": false,
|
|
@@ -5279,6 +5297,8 @@
|
|
|
5279
5297
|
"description": "The set of annotations present on this bot_defense_app_infrastructure.",
|
|
5280
5298
|
"title": "Annotations.",
|
|
5281
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.",
|
|
5282
5302
|
"x-f5xc-required-for": {
|
|
5283
5303
|
"minimum_config": false,
|
|
5284
5304
|
"create": false,
|
|
@@ -5291,6 +5311,7 @@
|
|
|
5291
5311
|
"description": "The description set for this bot_defense_app_infrastructure.",
|
|
5292
5312
|
"title": "Description.",
|
|
5293
5313
|
"x-displayname": "Description.",
|
|
5314
|
+
"x-f5xc-description-short": "The description set for this bot_defense_app_infrastructure.",
|
|
5294
5315
|
"minLength": 0,
|
|
5295
5316
|
"maxLength": 0,
|
|
5296
5317
|
"x-f5xc-required-for": {
|
|
@@ -5301,7 +5322,7 @@
|
|
|
5301
5322
|
},
|
|
5302
5323
|
"x-original-maxLength": 1024,
|
|
5303
5324
|
"x-reconciled-from-discovery": true,
|
|
5304
|
-
"x-reconciled-at": "2026-01-
|
|
5325
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949620+00:00"
|
|
5305
5326
|
},
|
|
5306
5327
|
"disabled": {
|
|
5307
5328
|
"type": "boolean",
|
|
@@ -5309,6 +5330,8 @@
|
|
|
5309
5330
|
"title": "Disabled",
|
|
5310
5331
|
"format": "boolean",
|
|
5311
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.",
|
|
5312
5335
|
"x-f5xc-required-for": {
|
|
5313
5336
|
"minimum_config": false,
|
|
5314
5337
|
"create": false,
|
|
@@ -5324,6 +5347,8 @@
|
|
|
5324
5347
|
"description": "The set of labels present on this bot_defense_app_infrastructure.",
|
|
5325
5348
|
"title": "Labels",
|
|
5326
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.",
|
|
5327
5352
|
"x-f5xc-required-for": {
|
|
5328
5353
|
"minimum_config": false,
|
|
5329
5354
|
"create": false,
|
|
@@ -5341,6 +5366,7 @@
|
|
|
5341
5366
|
"x-displayname": "Name",
|
|
5342
5367
|
"x-ves-example": "Name",
|
|
5343
5368
|
"x-f5xc-example": "name",
|
|
5369
|
+
"x-f5xc-description-short": "The name of this bot_defense_app_infrastructure.",
|
|
5344
5370
|
"minLength": 0,
|
|
5345
5371
|
"maxLength": 16,
|
|
5346
5372
|
"x-f5xc-required-for": {
|
|
@@ -5351,7 +5377,7 @@
|
|
|
5351
5377
|
},
|
|
5352
5378
|
"x-original-maxLength": 1024,
|
|
5353
5379
|
"x-reconciled-from-discovery": true,
|
|
5354
|
-
"x-reconciled-at": "2026-01-
|
|
5380
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949632+00:00"
|
|
5355
5381
|
},
|
|
5356
5382
|
"namespace": {
|
|
5357
5383
|
"type": "string",
|
|
@@ -5370,7 +5396,7 @@
|
|
|
5370
5396
|
},
|
|
5371
5397
|
"x-original-maxLength": 1024,
|
|
5372
5398
|
"x-reconciled-from-discovery": true,
|
|
5373
|
-
"x-reconciled-at": "2026-01-
|
|
5399
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949636+00:00"
|
|
5374
5400
|
},
|
|
5375
5401
|
"owner_view": {
|
|
5376
5402
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -5396,7 +5422,7 @@
|
|
|
5396
5422
|
"x-field-mutability": "read-only",
|
|
5397
5423
|
"x-original-maxLength": 1024,
|
|
5398
5424
|
"x-reconciled-from-discovery": true,
|
|
5399
|
-
"x-reconciled-at": "2026-01-
|
|
5425
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949643+00:00"
|
|
5400
5426
|
},
|
|
5401
5427
|
"uid": {
|
|
5402
5428
|
"type": "string",
|
|
@@ -5405,6 +5431,7 @@
|
|
|
5405
5431
|
"x-displayname": "UID",
|
|
5406
5432
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
5407
5433
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
5434
|
+
"x-f5xc-description-short": "The unique uid of this bot_defense_app_infrastructure.",
|
|
5408
5435
|
"minLength": 0,
|
|
5409
5436
|
"maxLength": 36,
|
|
5410
5437
|
"x-f5xc-required-for": {
|
|
@@ -5417,9 +5444,11 @@
|
|
|
5417
5444
|
"x-original-maxLength": 1024,
|
|
5418
5445
|
"format": "uuid",
|
|
5419
5446
|
"x-reconciled-from-discovery": true,
|
|
5420
|
-
"x-reconciled-at": "2026-01-
|
|
5447
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949649+00:00"
|
|
5421
5448
|
}
|
|
5422
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.",
|
|
5423
5452
|
"x-f5xc-minimum-configuration": {
|
|
5424
5453
|
"description": "Minimum configuration for bot_defense_app_infrastructureListResponseItem",
|
|
5425
5454
|
"required_fields": [
|
|
@@ -5504,6 +5533,7 @@
|
|
|
5504
5533
|
"$ref": "#/components/schemas/bot_defense_app_infrastructureTrafficType"
|
|
5505
5534
|
}
|
|
5506
5535
|
},
|
|
5536
|
+
"x-f5xc-description-short": "Replace a given Bot Defense App Infrastructure in a given namespace.",
|
|
5507
5537
|
"x-f5xc-minimum-configuration": {
|
|
5508
5538
|
"description": "Minimum configuration for bot_defense_app_infrastructureReplaceSpecType",
|
|
5509
5539
|
"required_fields": [
|
|
@@ -5530,6 +5560,7 @@
|
|
|
5530
5560
|
"default": "WEB",
|
|
5531
5561
|
"x-displayname": "Traffic Type.",
|
|
5532
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.",
|
|
5533
5564
|
"x-f5xc-minimum-configuration": {
|
|
5534
5565
|
"description": "Minimum configuration for bot_defense_app_infrastructureTrafficType",
|
|
5535
5566
|
"required_fields": [],
|
|
@@ -5554,6 +5585,8 @@
|
|
|
5554
5585
|
"x-displayname": "Kind",
|
|
5555
5586
|
"x-ves-example": "Virtual_site.",
|
|
5556
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\").",
|
|
5557
5590
|
"minLength": 0,
|
|
5558
5591
|
"maxLength": 14,
|
|
5559
5592
|
"x-f5xc-required-for": {
|
|
@@ -5565,7 +5598,7 @@
|
|
|
5565
5598
|
"readOnly": true,
|
|
5566
5599
|
"x-original-maxLength": 1024,
|
|
5567
5600
|
"x-reconciled-from-discovery": true,
|
|
5568
|
-
"x-reconciled-at": "2026-01-
|
|
5601
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949663+00:00"
|
|
5569
5602
|
},
|
|
5570
5603
|
"name": {
|
|
5571
5604
|
"type": "string",
|
|
@@ -5574,6 +5607,8 @@
|
|
|
5574
5607
|
"x-displayname": "Name",
|
|
5575
5608
|
"x-ves-example": "Contactus-route.",
|
|
5576
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.",
|
|
5577
5612
|
"minLength": 0,
|
|
5578
5613
|
"maxLength": 16,
|
|
5579
5614
|
"x-f5xc-required-for": {
|
|
@@ -5584,7 +5619,7 @@
|
|
|
5584
5619
|
},
|
|
5585
5620
|
"x-original-maxLength": 1024,
|
|
5586
5621
|
"x-reconciled-from-discovery": true,
|
|
5587
|
-
"x-reconciled-at": "2026-01-
|
|
5622
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949668+00:00"
|
|
5588
5623
|
},
|
|
5589
5624
|
"namespace": {
|
|
5590
5625
|
"type": "string",
|
|
@@ -5593,6 +5628,8 @@
|
|
|
5593
5628
|
"x-displayname": "Namespace",
|
|
5594
5629
|
"x-ves-example": "Ns1",
|
|
5595
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.",
|
|
5596
5633
|
"minLength": 0,
|
|
5597
5634
|
"maxLength": 6,
|
|
5598
5635
|
"x-f5xc-required-for": {
|
|
@@ -5603,7 +5640,7 @@
|
|
|
5603
5640
|
},
|
|
5604
5641
|
"x-original-maxLength": 1024,
|
|
5605
5642
|
"x-reconciled-from-discovery": true,
|
|
5606
|
-
"x-reconciled-at": "2026-01-
|
|
5643
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949672+00:00"
|
|
5607
5644
|
},
|
|
5608
5645
|
"tenant": {
|
|
5609
5646
|
"type": "string",
|
|
@@ -5612,6 +5649,8 @@
|
|
|
5612
5649
|
"x-displayname": "Tenant",
|
|
5613
5650
|
"x-ves-example": "Example-corp.",
|
|
5614
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.",
|
|
5615
5654
|
"minLength": 0,
|
|
5616
5655
|
"maxLength": 18,
|
|
5617
5656
|
"x-f5xc-required-for": {
|
|
@@ -5624,7 +5663,7 @@
|
|
|
5624
5663
|
"x-field-mutability": "read-only",
|
|
5625
5664
|
"x-original-maxLength": 1024,
|
|
5626
5665
|
"x-reconciled-from-discovery": true,
|
|
5627
|
-
"x-reconciled-at": "2026-01-
|
|
5666
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949676+00:00"
|
|
5628
5667
|
},
|
|
5629
5668
|
"uid": {
|
|
5630
5669
|
"type": "string",
|
|
@@ -5633,6 +5672,8 @@
|
|
|
5633
5672
|
"x-displayname": "UID",
|
|
5634
5673
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
5635
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.",
|
|
5636
5677
|
"minLength": 0,
|
|
5637
5678
|
"maxLength": 36,
|
|
5638
5679
|
"x-f5xc-required-for": {
|
|
@@ -5646,9 +5687,11 @@
|
|
|
5646
5687
|
"x-original-maxLength": 1024,
|
|
5647
5688
|
"format": "uuid",
|
|
5648
5689
|
"x-reconciled-from-discovery": true,
|
|
5649
|
-
"x-reconciled-at": "2026-01-
|
|
5690
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949682+00:00"
|
|
5650
5691
|
}
|
|
5651
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...",
|
|
5652
5695
|
"x-f5xc-minimum-configuration": {
|
|
5653
5696
|
"description": "Minimum configuration for ioschemaObjectRefType",
|
|
5654
5697
|
"required_fields": [
|
|
@@ -5672,6 +5715,8 @@
|
|
|
5672
5715
|
"type_url": {
|
|
5673
5716
|
"type": "string",
|
|
5674
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 ).",
|
|
5675
5720
|
"minLength": 0,
|
|
5676
5721
|
"maxLength": 1024,
|
|
5677
5722
|
"x-f5xc-required-for": {
|
|
@@ -5695,9 +5740,11 @@
|
|
|
5695
5740
|
},
|
|
5696
5741
|
"x-original-maxLength": 1024,
|
|
5697
5742
|
"x-reconciled-from-discovery": true,
|
|
5698
|
-
"x-reconciled-at": "2026-01-
|
|
5743
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949688+00:00"
|
|
5699
5744
|
}
|
|
5700
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...",
|
|
5701
5748
|
"x-f5xc-minimum-configuration": {
|
|
5702
5749
|
"description": "Minimum configuration for protobufAny",
|
|
5703
5750
|
"required_fields": [
|
|
@@ -5729,6 +5776,8 @@
|
|
|
5729
5776
|
"default": "EOK",
|
|
5730
5777
|
"x-displayname": "Error Code.",
|
|
5731
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...",
|
|
5732
5781
|
"x-f5xc-minimum-configuration": {
|
|
5733
5782
|
"description": "Minimum configuration for schemaErrorCode",
|
|
5734
5783
|
"required_fields": [],
|
|
@@ -5769,6 +5818,7 @@
|
|
|
5769
5818
|
}
|
|
5770
5819
|
}
|
|
5771
5820
|
},
|
|
5821
|
+
"x-f5xc-description-short": "Information about a error in API operation.",
|
|
5772
5822
|
"x-f5xc-minimum-configuration": {
|
|
5773
5823
|
"description": "Minimum configuration for schemaErrorType",
|
|
5774
5824
|
"required_fields": [
|
|
@@ -5796,6 +5846,7 @@
|
|
|
5796
5846
|
"title": "Name",
|
|
5797
5847
|
"x-displayname": "Name",
|
|
5798
5848
|
"x-f5xc-example": "example-resource",
|
|
5849
|
+
"x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
|
|
5799
5850
|
"minLength": 0,
|
|
5800
5851
|
"maxLength": 16,
|
|
5801
5852
|
"x-f5xc-required-for": {
|
|
@@ -5806,9 +5857,10 @@
|
|
|
5806
5857
|
},
|
|
5807
5858
|
"x-original-maxLength": 1024,
|
|
5808
5859
|
"x-reconciled-from-discovery": true,
|
|
5809
|
-
"x-reconciled-at": "2026-01-
|
|
5860
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949698+00:00"
|
|
5810
5861
|
}
|
|
5811
5862
|
},
|
|
5863
|
+
"x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
|
|
5812
5864
|
"x-f5xc-minimum-configuration": {
|
|
5813
5865
|
"description": "Minimum configuration for schemaInitializerType",
|
|
5814
5866
|
"required_fields": [
|
|
@@ -5836,6 +5888,8 @@
|
|
|
5836
5888
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
5837
5889
|
},
|
|
5838
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.",
|
|
5839
5893
|
"x-f5xc-required-for": {
|
|
5840
5894
|
"minimum_config": false,
|
|
5841
5895
|
"create": false,
|
|
@@ -5847,6 +5901,7 @@
|
|
|
5847
5901
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
5848
5902
|
}
|
|
5849
5903
|
},
|
|
5904
|
+
"x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
|
|
5850
5905
|
"x-f5xc-minimum-configuration": {
|
|
5851
5906
|
"description": "Minimum configuration for schemaInitializersType",
|
|
5852
5907
|
"required_fields": [
|
|
@@ -5885,6 +5940,8 @@
|
|
|
5885
5940
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
5886
5941
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
5887
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.",
|
|
5888
5945
|
"x-f5xc-required-for": {
|
|
5889
5946
|
"minimum_config": false,
|
|
5890
5947
|
"create": false,
|
|
@@ -5906,6 +5963,7 @@
|
|
|
5906
5963
|
"x-validation-rules": {
|
|
5907
5964
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
5908
5965
|
},
|
|
5966
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
5909
5967
|
"minLength": 0,
|
|
5910
5968
|
"x-f5xc-required-for": {
|
|
5911
5969
|
"minimum_config": false,
|
|
@@ -5915,7 +5973,7 @@
|
|
|
5915
5973
|
},
|
|
5916
5974
|
"x-original-maxLength": 1200,
|
|
5917
5975
|
"x-reconciled-from-discovery": true,
|
|
5918
|
-
"x-reconciled-at": "2026-01-
|
|
5976
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949708+00:00"
|
|
5919
5977
|
},
|
|
5920
5978
|
"disable": {
|
|
5921
5979
|
"type": "boolean",
|
|
@@ -5924,6 +5982,7 @@
|
|
|
5924
5982
|
"format": "boolean",
|
|
5925
5983
|
"x-displayname": "Disable",
|
|
5926
5984
|
"x-f5xc-example": "true",
|
|
5985
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
5927
5986
|
"x-f5xc-required-for": {
|
|
5928
5987
|
"minimum_config": false,
|
|
5929
5988
|
"create": false,
|
|
@@ -5937,6 +5996,8 @@
|
|
|
5937
5996
|
"title": "Labels",
|
|
5938
5997
|
"x-displayname": "Labels",
|
|
5939
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.",
|
|
5940
6001
|
"x-f5xc-required-for": {
|
|
5941
6002
|
"minimum_config": false,
|
|
5942
6003
|
"create": false,
|
|
@@ -5958,6 +6019,8 @@
|
|
|
5958
6019
|
"x-validation-rules": {
|
|
5959
6020
|
"ves.io.schema.rules.message.required": "true"
|
|
5960
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.",
|
|
5961
6024
|
"minLength": 0,
|
|
5962
6025
|
"maxLength": 16,
|
|
5963
6026
|
"x-f5xc-required-for": {
|
|
@@ -5968,7 +6031,7 @@
|
|
|
5968
6031
|
},
|
|
5969
6032
|
"x-original-maxLength": 1024,
|
|
5970
6033
|
"x-reconciled-from-discovery": true,
|
|
5971
|
-
"x-reconciled-at": "2026-01-
|
|
6034
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949716+00:00"
|
|
5972
6035
|
},
|
|
5973
6036
|
"namespace": {
|
|
5974
6037
|
"type": "string",
|
|
@@ -5977,6 +6040,8 @@
|
|
|
5977
6040
|
"x-displayname": "Namespace",
|
|
5978
6041
|
"x-ves-example": "Staging",
|
|
5979
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 \"\".",
|
|
5980
6045
|
"minLength": 0,
|
|
5981
6046
|
"maxLength": 6,
|
|
5982
6047
|
"x-f5xc-required-for": {
|
|
@@ -5987,9 +6052,10 @@
|
|
|
5987
6052
|
},
|
|
5988
6053
|
"x-original-maxLength": 1024,
|
|
5989
6054
|
"x-reconciled-from-discovery": true,
|
|
5990
|
-
"x-reconciled-at": "2026-01-
|
|
6055
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949720+00:00"
|
|
5991
6056
|
}
|
|
5992
6057
|
},
|
|
6058
|
+
"x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
|
|
5993
6059
|
"x-f5xc-minimum-configuration": {
|
|
5994
6060
|
"description": "Minimum configuration for schemaObjectCreateMetaType",
|
|
5995
6061
|
"required_fields": [
|
|
@@ -6033,6 +6099,8 @@
|
|
|
6033
6099
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
6034
6100
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
6035
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.",
|
|
6036
6104
|
"x-f5xc-required-for": {
|
|
6037
6105
|
"minimum_config": false,
|
|
6038
6106
|
"create": false,
|
|
@@ -6054,6 +6122,7 @@
|
|
|
6054
6122
|
"x-validation-rules": {
|
|
6055
6123
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
6056
6124
|
},
|
|
6125
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
6057
6126
|
"minLength": 0,
|
|
6058
6127
|
"x-f5xc-required-for": {
|
|
6059
6128
|
"minimum_config": false,
|
|
@@ -6063,7 +6132,7 @@
|
|
|
6063
6132
|
},
|
|
6064
6133
|
"x-original-maxLength": 1200,
|
|
6065
6134
|
"x-reconciled-from-discovery": true,
|
|
6066
|
-
"x-reconciled-at": "2026-01-
|
|
6135
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949726+00:00"
|
|
6067
6136
|
},
|
|
6068
6137
|
"disable": {
|
|
6069
6138
|
"type": "boolean",
|
|
@@ -6073,6 +6142,7 @@
|
|
|
6073
6142
|
"x-displayname": "Disable",
|
|
6074
6143
|
"x-ves-example": "True",
|
|
6075
6144
|
"x-f5xc-example": "true",
|
|
6145
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
6076
6146
|
"x-f5xc-required-for": {
|
|
6077
6147
|
"minimum_config": false,
|
|
6078
6148
|
"create": false,
|
|
@@ -6087,6 +6157,8 @@
|
|
|
6087
6157
|
"x-displayname": "Labels",
|
|
6088
6158
|
"x-ves-example": "Value",
|
|
6089
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.",
|
|
6090
6162
|
"x-f5xc-required-for": {
|
|
6091
6163
|
"minimum_config": false,
|
|
6092
6164
|
"create": false,
|
|
@@ -6108,6 +6180,8 @@
|
|
|
6108
6180
|
"x-validation-rules": {
|
|
6109
6181
|
"ves.io.schema.rules.message.required": "true"
|
|
6110
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.",
|
|
6111
6185
|
"minLength": 0,
|
|
6112
6186
|
"maxLength": 16,
|
|
6113
6187
|
"x-f5xc-required-for": {
|
|
@@ -6118,7 +6192,7 @@
|
|
|
6118
6192
|
},
|
|
6119
6193
|
"x-original-maxLength": 1024,
|
|
6120
6194
|
"x-reconciled-from-discovery": true,
|
|
6121
|
-
"x-reconciled-at": "2026-01-
|
|
6195
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949733+00:00"
|
|
6122
6196
|
},
|
|
6123
6197
|
"namespace": {
|
|
6124
6198
|
"type": "string",
|
|
@@ -6127,6 +6201,8 @@
|
|
|
6127
6201
|
"x-displayname": "Namespace",
|
|
6128
6202
|
"x-ves-example": "Staging",
|
|
6129
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 \"\".",
|
|
6130
6206
|
"minLength": 0,
|
|
6131
6207
|
"maxLength": 6,
|
|
6132
6208
|
"x-f5xc-required-for": {
|
|
@@ -6137,9 +6213,10 @@
|
|
|
6137
6213
|
},
|
|
6138
6214
|
"x-original-maxLength": 1024,
|
|
6139
6215
|
"x-reconciled-from-discovery": true,
|
|
6140
|
-
"x-reconciled-at": "2026-01-
|
|
6216
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949737+00:00"
|
|
6141
6217
|
}
|
|
6142
6218
|
},
|
|
6219
|
+
"x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
|
|
6143
6220
|
"x-f5xc-minimum-configuration": {
|
|
6144
6221
|
"description": "Minimum configuration for schemaObjectGetMetaType",
|
|
6145
6222
|
"required_fields": [
|
|
@@ -6183,6 +6260,8 @@
|
|
|
6183
6260
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
6184
6261
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
6185
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.",
|
|
6186
6265
|
"x-f5xc-required-for": {
|
|
6187
6266
|
"minimum_config": false,
|
|
6188
6267
|
"create": false,
|
|
@@ -6204,6 +6283,7 @@
|
|
|
6204
6283
|
"x-validation-rules": {
|
|
6205
6284
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
6206
6285
|
},
|
|
6286
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
6207
6287
|
"minLength": 0,
|
|
6208
6288
|
"x-f5xc-required-for": {
|
|
6209
6289
|
"minimum_config": false,
|
|
@@ -6213,7 +6293,7 @@
|
|
|
6213
6293
|
},
|
|
6214
6294
|
"x-original-maxLength": 1200,
|
|
6215
6295
|
"x-reconciled-from-discovery": true,
|
|
6216
|
-
"x-reconciled-at": "2026-01-
|
|
6296
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949744+00:00"
|
|
6217
6297
|
},
|
|
6218
6298
|
"disable": {
|
|
6219
6299
|
"type": "boolean",
|
|
@@ -6222,6 +6302,7 @@
|
|
|
6222
6302
|
"format": "boolean",
|
|
6223
6303
|
"x-displayname": "Disable",
|
|
6224
6304
|
"x-f5xc-example": "true",
|
|
6305
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
6225
6306
|
"x-f5xc-required-for": {
|
|
6226
6307
|
"minimum_config": false,
|
|
6227
6308
|
"create": false,
|
|
@@ -6236,6 +6317,8 @@
|
|
|
6236
6317
|
"x-displayname": "Labels",
|
|
6237
6318
|
"x-ves-example": "Value",
|
|
6238
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.",
|
|
6239
6322
|
"x-f5xc-required-for": {
|
|
6240
6323
|
"minimum_config": false,
|
|
6241
6324
|
"create": false,
|
|
@@ -6256,6 +6339,8 @@
|
|
|
6256
6339
|
"x-validation-rules": {
|
|
6257
6340
|
"ves.io.schema.rules.message.required": "true"
|
|
6258
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.",
|
|
6259
6344
|
"minLength": 0,
|
|
6260
6345
|
"maxLength": 16,
|
|
6261
6346
|
"x-f5xc-required-for": {
|
|
@@ -6266,7 +6351,7 @@
|
|
|
6266
6351
|
},
|
|
6267
6352
|
"x-original-maxLength": 1024,
|
|
6268
6353
|
"x-reconciled-from-discovery": true,
|
|
6269
|
-
"x-reconciled-at": "2026-01-
|
|
6354
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949750+00:00"
|
|
6270
6355
|
},
|
|
6271
6356
|
"namespace": {
|
|
6272
6357
|
"type": "string",
|
|
@@ -6275,6 +6360,8 @@
|
|
|
6275
6360
|
"x-displayname": "Namespace",
|
|
6276
6361
|
"x-ves-example": "Staging",
|
|
6277
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 \"\".",
|
|
6278
6365
|
"minLength": 0,
|
|
6279
6366
|
"maxLength": 6,
|
|
6280
6367
|
"x-f5xc-required-for": {
|
|
@@ -6285,9 +6372,10 @@
|
|
|
6285
6372
|
},
|
|
6286
6373
|
"x-original-maxLength": 1024,
|
|
6287
6374
|
"x-reconciled-from-discovery": true,
|
|
6288
|
-
"x-reconciled-at": "2026-01-
|
|
6375
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949754+00:00"
|
|
6289
6376
|
}
|
|
6290
6377
|
},
|
|
6378
|
+
"x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
|
|
6291
6379
|
"x-f5xc-minimum-configuration": {
|
|
6292
6380
|
"description": "Minimum configuration for schemaObjectReplaceMetaType",
|
|
6293
6381
|
"required_fields": [
|
|
@@ -6320,6 +6408,7 @@
|
|
|
6320
6408
|
"x-displayname": "Code",
|
|
6321
6409
|
"x-ves-example": "0",
|
|
6322
6410
|
"x-f5xc-example": "0",
|
|
6411
|
+
"x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
|
|
6323
6412
|
"minimum": 0,
|
|
6324
6413
|
"maximum": 2147483647,
|
|
6325
6414
|
"x-f5xc-required-for": {
|
|
@@ -6336,6 +6425,8 @@
|
|
|
6336
6425
|
"x-displayname": "Reason",
|
|
6337
6426
|
"x-ves-example": "Value",
|
|
6338
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.",
|
|
6339
6430
|
"minLength": 0,
|
|
6340
6431
|
"maxLength": 43,
|
|
6341
6432
|
"x-f5xc-required-for": {
|
|
@@ -6346,7 +6437,7 @@
|
|
|
6346
6437
|
},
|
|
6347
6438
|
"x-original-maxLength": 1024,
|
|
6348
6439
|
"x-reconciled-from-discovery": true,
|
|
6349
|
-
"x-reconciled-at": "2026-01-
|
|
6440
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949760+00:00"
|
|
6350
6441
|
},
|
|
6351
6442
|
"status": {
|
|
6352
6443
|
"type": "string",
|
|
@@ -6355,6 +6446,7 @@
|
|
|
6355
6446
|
"x-displayname": "Status",
|
|
6356
6447
|
"x-ves-example": "Value",
|
|
6357
6448
|
"x-f5xc-example": "value",
|
|
6449
|
+
"x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
|
|
6358
6450
|
"minLength": 0,
|
|
6359
6451
|
"maxLength": 17,
|
|
6360
6452
|
"x-f5xc-required-for": {
|
|
@@ -6365,9 +6457,10 @@
|
|
|
6365
6457
|
},
|
|
6366
6458
|
"x-original-maxLength": 1024,
|
|
6367
6459
|
"x-reconciled-from-discovery": true,
|
|
6368
|
-
"x-reconciled-at": "2026-01-
|
|
6460
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949764+00:00"
|
|
6369
6461
|
}
|
|
6370
6462
|
},
|
|
6463
|
+
"x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
|
|
6371
6464
|
"x-f5xc-minimum-configuration": {
|
|
6372
6465
|
"description": "Minimum configuration for schemaStatusType",
|
|
6373
6466
|
"required_fields": [
|
|
@@ -6395,6 +6488,8 @@
|
|
|
6395
6488
|
"title": "Creation_timestamp.",
|
|
6396
6489
|
"format": "date-time",
|
|
6397
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.",
|
|
6398
6493
|
"minLength": 0,
|
|
6399
6494
|
"maxLength": 1024,
|
|
6400
6495
|
"x-f5xc-required-for": {
|
|
@@ -6412,6 +6507,7 @@
|
|
|
6412
6507
|
"x-displayname": "Creator Class.",
|
|
6413
6508
|
"x-ves-example": "Prism",
|
|
6414
6509
|
"x-f5xc-example": "value",
|
|
6510
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
6415
6511
|
"minLength": 0,
|
|
6416
6512
|
"maxLength": 1024,
|
|
6417
6513
|
"x-f5xc-required-for": {
|
|
@@ -6429,6 +6525,7 @@
|
|
|
6429
6525
|
"x-displayname": "Creator ID.",
|
|
6430
6526
|
"x-ves-example": "Admin@example-corp.com.",
|
|
6431
6527
|
"x-f5xc-example": "value",
|
|
6528
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
6432
6529
|
"minLength": 0,
|
|
6433
6530
|
"maxLength": 1024,
|
|
6434
6531
|
"x-f5xc-required-for": {
|
|
@@ -6445,6 +6542,8 @@
|
|
|
6445
6542
|
"title": "Deletion_timestamp.",
|
|
6446
6543
|
"format": "date-time",
|
|
6447
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...",
|
|
6448
6547
|
"minLength": 0,
|
|
6449
6548
|
"maxLength": 1024,
|
|
6450
6549
|
"x-f5xc-required-for": {
|
|
@@ -6464,6 +6563,8 @@
|
|
|
6464
6563
|
"x-displayname": "Finalizers.",
|
|
6465
6564
|
"x-ves-example": "Value",
|
|
6466
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.",
|
|
6467
6568
|
"x-f5xc-required-for": {
|
|
6468
6569
|
"minimum_config": false,
|
|
6469
6570
|
"create": false,
|
|
@@ -6481,6 +6582,8 @@
|
|
|
6481
6582
|
"x-displayname": "Labels",
|
|
6482
6583
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
6483
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).",
|
|
6484
6587
|
"x-f5xc-required-for": {
|
|
6485
6588
|
"minimum_config": false,
|
|
6486
6589
|
"create": false,
|
|
@@ -6494,6 +6597,8 @@
|
|
|
6494
6597
|
"title": "Modification_timestamp.",
|
|
6495
6598
|
"format": "date-time",
|
|
6496
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.",
|
|
6497
6602
|
"minLength": 0,
|
|
6498
6603
|
"maxLength": 1024,
|
|
6499
6604
|
"x-f5xc-required-for": {
|
|
@@ -6512,6 +6617,8 @@
|
|
|
6512
6617
|
"x-displayname": "Object Index.",
|
|
6513
6618
|
"x-ves-example": "0",
|
|
6514
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.",
|
|
6515
6622
|
"minimum": 0,
|
|
6516
6623
|
"maximum": 2147483647,
|
|
6517
6624
|
"x-f5xc-required-for": {
|
|
@@ -6532,6 +6639,8 @@
|
|
|
6532
6639
|
"x-displayname": "Tenant",
|
|
6533
6640
|
"x-ves-example": "Example-corp.",
|
|
6534
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.",
|
|
6535
6644
|
"minLength": 0,
|
|
6536
6645
|
"maxLength": 18,
|
|
6537
6646
|
"x-f5xc-required-for": {
|
|
@@ -6543,7 +6652,7 @@
|
|
|
6543
6652
|
"x-field-mutability": "read-only",
|
|
6544
6653
|
"x-original-maxLength": 1024,
|
|
6545
6654
|
"x-reconciled-from-discovery": true,
|
|
6546
|
-
"x-reconciled-at": "2026-01-
|
|
6655
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949783+00:00"
|
|
6547
6656
|
},
|
|
6548
6657
|
"uid": {
|
|
6549
6658
|
"type": "string",
|
|
@@ -6552,6 +6661,8 @@
|
|
|
6552
6661
|
"x-displayname": "UID",
|
|
6553
6662
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
6554
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.",
|
|
6555
6666
|
"minLength": 0,
|
|
6556
6667
|
"maxLength": 36,
|
|
6557
6668
|
"x-f5xc-required-for": {
|
|
@@ -6564,9 +6675,11 @@
|
|
|
6564
6675
|
"x-original-maxLength": 1024,
|
|
6565
6676
|
"format": "uuid",
|
|
6566
6677
|
"x-reconciled-from-discovery": true,
|
|
6567
|
-
"x-reconciled-at": "2026-01-
|
|
6678
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949788+00:00"
|
|
6568
6679
|
}
|
|
6569
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.",
|
|
6570
6683
|
"x-f5xc-minimum-configuration": {
|
|
6571
6684
|
"description": "Minimum configuration for schemaSystemObjectGetMetaType",
|
|
6572
6685
|
"required_fields": [
|
|
@@ -6614,7 +6727,7 @@
|
|
|
6614
6727
|
},
|
|
6615
6728
|
"x-original-maxLength": 1024,
|
|
6616
6729
|
"x-reconciled-from-discovery": true,
|
|
6617
|
-
"x-reconciled-at": "2026-01-
|
|
6730
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949793+00:00"
|
|
6618
6731
|
},
|
|
6619
6732
|
"name": {
|
|
6620
6733
|
"type": "string",
|
|
@@ -6623,6 +6736,8 @@
|
|
|
6623
6736
|
"x-displayname": "Name",
|
|
6624
6737
|
"x-ves-example": "Contactus-route.",
|
|
6625
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.",
|
|
6626
6741
|
"minLength": 0,
|
|
6627
6742
|
"maxLength": 16,
|
|
6628
6743
|
"x-f5xc-required-for": {
|
|
@@ -6633,7 +6748,7 @@
|
|
|
6633
6748
|
},
|
|
6634
6749
|
"x-original-maxLength": 1024,
|
|
6635
6750
|
"x-reconciled-from-discovery": true,
|
|
6636
|
-
"x-reconciled-at": "2026-01-
|
|
6751
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949797+00:00"
|
|
6637
6752
|
},
|
|
6638
6753
|
"namespace": {
|
|
6639
6754
|
"type": "string",
|
|
@@ -6642,6 +6757,8 @@
|
|
|
6642
6757
|
"x-displayname": "Namespace",
|
|
6643
6758
|
"x-ves-example": "Ns1",
|
|
6644
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.",
|
|
6645
6762
|
"minLength": 0,
|
|
6646
6763
|
"maxLength": 6,
|
|
6647
6764
|
"x-f5xc-required-for": {
|
|
@@ -6652,7 +6769,7 @@
|
|
|
6652
6769
|
},
|
|
6653
6770
|
"x-original-maxLength": 1024,
|
|
6654
6771
|
"x-reconciled-from-discovery": true,
|
|
6655
|
-
"x-reconciled-at": "2026-01-
|
|
6772
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949800+00:00"
|
|
6656
6773
|
},
|
|
6657
6774
|
"uid": {
|
|
6658
6775
|
"type": "string",
|
|
@@ -6673,9 +6790,10 @@
|
|
|
6673
6790
|
"x-original-maxLength": 1024,
|
|
6674
6791
|
"format": "uuid",
|
|
6675
6792
|
"x-reconciled-from-discovery": true,
|
|
6676
|
-
"x-reconciled-at": "2026-01-
|
|
6793
|
+
"x-reconciled-at": "2026-01-07T15:27:59.949805+00:00"
|
|
6677
6794
|
}
|
|
6678
6795
|
},
|
|
6796
|
+
"x-f5xc-description-short": "ViewRefType represents a reference to a view.",
|
|
6679
6797
|
"x-f5xc-minimum-configuration": {
|
|
6680
6798
|
"description": "Minimum configuration for schemaViewRefType",
|
|
6681
6799
|
"required_fields": [
|
|
@@ -6737,6 +6855,8 @@
|
|
|
6737
6855
|
"default": "AWS_AP_NORTHEAST_1",
|
|
6738
6856
|
"x-displayname": "Location",
|
|
6739
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...",
|
|
6740
6860
|
"x-f5xc-minimum-configuration": {
|
|
6741
6861
|
"description": "Minimum configuration for viewsbot_defense_app_infrastructureLocation",
|
|
6742
6862
|
"required_fields": [],
|
|
@@ -6753,6 +6873,7 @@
|
|
|
6753
6873
|
"title": "GET virtual host.",
|
|
6754
6874
|
"x-displayname": "GET Virtual Host.",
|
|
6755
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.",
|
|
6756
6877
|
"x-f5xc-minimum-configuration": {
|
|
6757
6878
|
"description": "Minimum configuration for schemashape_bot_defense_instanceGetSpecType",
|
|
6758
6879
|
"required_fields": [],
|
|
@@ -6778,6 +6899,7 @@
|
|
|
6778
6899
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
6779
6900
|
},
|
|
6780
6901
|
"x-displayname": "Deleted Referred Objects.",
|
|
6902
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6781
6903
|
"x-f5xc-required-for": {
|
|
6782
6904
|
"minimum_config": false,
|
|
6783
6905
|
"create": false,
|
|
@@ -6793,6 +6915,7 @@
|
|
|
6793
6915
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
6794
6916
|
},
|
|
6795
6917
|
"x-displayname": "Disabled Referred Objects.",
|
|
6918
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6796
6919
|
"x-f5xc-required-for": {
|
|
6797
6920
|
"minimum_config": false,
|
|
6798
6921
|
"create": false,
|
|
@@ -6811,6 +6934,7 @@
|
|
|
6811
6934
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
6812
6935
|
},
|
|
6813
6936
|
"x-displayname": "Referring Objects.",
|
|
6937
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
6814
6938
|
"x-f5xc-required-for": {
|
|
6815
6939
|
"minimum_config": false,
|
|
6816
6940
|
"create": false,
|
|
@@ -6853,6 +6977,8 @@
|
|
|
6853
6977
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
6854
6978
|
],
|
|
6855
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...",
|
|
6856
6982
|
"x-f5xc-minimum-configuration": {
|
|
6857
6983
|
"description": "Minimum configuration for shape_bot_defense_instanceGetResponseFormatCode",
|
|
6858
6984
|
"required_fields": [],
|
|
@@ -6878,6 +7004,7 @@
|
|
|
6878
7004
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
6879
7005
|
},
|
|
6880
7006
|
"x-displayname": "Errors",
|
|
7007
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
6881
7008
|
"x-f5xc-required-for": {
|
|
6882
7009
|
"minimum_config": false,
|
|
6883
7010
|
"create": false,
|
|
@@ -6893,6 +7020,8 @@
|
|
|
6893
7020
|
"$ref": "#/components/schemas/shape_bot_defense_instanceListResponseItem"
|
|
6894
7021
|
},
|
|
6895
7022
|
"x-displayname": "Items",
|
|
7023
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
7024
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
6896
7025
|
"x-f5xc-required-for": {
|
|
6897
7026
|
"minimum_config": false,
|
|
6898
7027
|
"create": false,
|
|
@@ -6926,6 +7055,8 @@
|
|
|
6926
7055
|
"description": "The set of annotations present on this shape_bot_defense_instance.",
|
|
6927
7056
|
"title": "Annotations.",
|
|
6928
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.",
|
|
6929
7060
|
"x-f5xc-required-for": {
|
|
6930
7061
|
"minimum_config": false,
|
|
6931
7062
|
"create": false,
|
|
@@ -6938,6 +7069,7 @@
|
|
|
6938
7069
|
"description": "The description set for this shape_bot_defense_instance.",
|
|
6939
7070
|
"title": "Description.",
|
|
6940
7071
|
"x-displayname": "Description.",
|
|
7072
|
+
"x-f5xc-description-short": "The description set for this shape_bot_defense_instance.",
|
|
6941
7073
|
"minLength": 0,
|
|
6942
7074
|
"maxLength": 0,
|
|
6943
7075
|
"x-f5xc-required-for": {
|
|
@@ -6948,7 +7080,7 @@
|
|
|
6948
7080
|
},
|
|
6949
7081
|
"x-original-maxLength": 1024,
|
|
6950
7082
|
"x-reconciled-from-discovery": true,
|
|
6951
|
-
"x-reconciled-at": "2026-01-
|
|
7083
|
+
"x-reconciled-at": "2026-01-07T15:29:21.065598+00:00"
|
|
6952
7084
|
},
|
|
6953
7085
|
"disabled": {
|
|
6954
7086
|
"type": "boolean",
|
|
@@ -6956,6 +7088,8 @@
|
|
|
6956
7088
|
"title": "Disabled",
|
|
6957
7089
|
"format": "boolean",
|
|
6958
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.",
|
|
6959
7093
|
"x-f5xc-required-for": {
|
|
6960
7094
|
"minimum_config": false,
|
|
6961
7095
|
"create": false,
|
|
@@ -6971,6 +7105,8 @@
|
|
|
6971
7105
|
"description": "The set of labels present on this shape_bot_defense_instance.",
|
|
6972
7106
|
"title": "Labels",
|
|
6973
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.",
|
|
6974
7110
|
"x-f5xc-required-for": {
|
|
6975
7111
|
"minimum_config": false,
|
|
6976
7112
|
"create": false,
|
|
@@ -6988,6 +7124,7 @@
|
|
|
6988
7124
|
"x-displayname": "Name",
|
|
6989
7125
|
"x-ves-example": "Name",
|
|
6990
7126
|
"x-f5xc-example": "name",
|
|
7127
|
+
"x-f5xc-description-short": "The name of this shape_bot_defense_instance.",
|
|
6991
7128
|
"minLength": 0,
|
|
6992
7129
|
"maxLength": 16,
|
|
6993
7130
|
"x-f5xc-required-for": {
|
|
@@ -6998,7 +7135,7 @@
|
|
|
6998
7135
|
},
|
|
6999
7136
|
"x-original-maxLength": 1024,
|
|
7000
7137
|
"x-reconciled-from-discovery": true,
|
|
7001
|
-
"x-reconciled-at": "2026-01-
|
|
7138
|
+
"x-reconciled-at": "2026-01-07T15:29:21.065608+00:00"
|
|
7002
7139
|
},
|
|
7003
7140
|
"namespace": {
|
|
7004
7141
|
"type": "string",
|
|
@@ -7017,7 +7154,7 @@
|
|
|
7017
7154
|
},
|
|
7018
7155
|
"x-original-maxLength": 1024,
|
|
7019
7156
|
"x-reconciled-from-discovery": true,
|
|
7020
|
-
"x-reconciled-at": "2026-01-
|
|
7157
|
+
"x-reconciled-at": "2026-01-07T15:29:21.065612+00:00"
|
|
7021
7158
|
},
|
|
7022
7159
|
"owner_view": {
|
|
7023
7160
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -7043,7 +7180,7 @@
|
|
|
7043
7180
|
"x-field-mutability": "read-only",
|
|
7044
7181
|
"x-original-maxLength": 1024,
|
|
7045
7182
|
"x-reconciled-from-discovery": true,
|
|
7046
|
-
"x-reconciled-at": "2026-01-
|
|
7183
|
+
"x-reconciled-at": "2026-01-07T15:29:21.065618+00:00"
|
|
7047
7184
|
},
|
|
7048
7185
|
"uid": {
|
|
7049
7186
|
"type": "string",
|
|
@@ -7052,6 +7189,7 @@
|
|
|
7052
7189
|
"x-displayname": "UID",
|
|
7053
7190
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
7054
7191
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
7192
|
+
"x-f5xc-description-short": "The unique uid of this shape_bot_defense_instance.",
|
|
7055
7193
|
"minLength": 0,
|
|
7056
7194
|
"maxLength": 36,
|
|
7057
7195
|
"x-f5xc-required-for": {
|
|
@@ -7064,9 +7202,11 @@
|
|
|
7064
7202
|
"x-original-maxLength": 1024,
|
|
7065
7203
|
"format": "uuid",
|
|
7066
7204
|
"x-reconciled-from-discovery": true,
|
|
7067
|
-
"x-reconciled-at": "2026-01-
|
|
7205
|
+
"x-reconciled-at": "2026-01-07T15:29:21.065623+00:00"
|
|
7068
7206
|
}
|
|
7069
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.",
|
|
7070
7210
|
"x-f5xc-minimum-configuration": {
|
|
7071
7211
|
"description": "Minimum configuration for shape_bot_defense_instanceListResponseItem",
|
|
7072
7212
|
"required_fields": [
|
|
@@ -7102,6 +7242,8 @@
|
|
|
7102
7242
|
"description": "Hostname of the instance of the site that sent the status.",
|
|
7103
7243
|
"title": "Hostname",
|
|
7104
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.",
|
|
7105
7247
|
"minLength": 0,
|
|
7106
7248
|
"maxLength": 1024,
|
|
7107
7249
|
"x-f5xc-required-for": {
|
|
@@ -7133,6 +7275,8 @@
|
|
|
7133
7275
|
"x-displayname": "Reason",
|
|
7134
7276
|
"x-ves-example": "Value",
|
|
7135
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.",
|
|
7136
7280
|
"minLength": 0,
|
|
7137
7281
|
"maxLength": 43,
|
|
7138
7282
|
"x-f5xc-required-for": {
|
|
@@ -7143,13 +7287,15 @@
|
|
|
7143
7287
|
},
|
|
7144
7288
|
"x-original-maxLength": 1024,
|
|
7145
7289
|
"x-reconciled-from-discovery": true,
|
|
7146
|
-
"x-reconciled-at": "2026-01-
|
|
7290
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138327+00:00"
|
|
7147
7291
|
},
|
|
7148
7292
|
"service_name": {
|
|
7149
7293
|
"type": "string",
|
|
7150
7294
|
"description": "Name of the service that sent the status.",
|
|
7151
7295
|
"title": "Service name.",
|
|
7152
7296
|
"x-displayname": "Service Name.",
|
|
7297
|
+
"x-f5xc-example": "example-resource",
|
|
7298
|
+
"x-f5xc-description-short": "Name of the service that sent the status.",
|
|
7153
7299
|
"minLength": 0,
|
|
7154
7300
|
"maxLength": 1024,
|
|
7155
7301
|
"x-f5xc-required-for": {
|
|
@@ -7172,6 +7318,8 @@
|
|
|
7172
7318
|
"x-validation-rules": {
|
|
7173
7319
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
|
|
7174
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...",
|
|
7175
7323
|
"minLength": 0,
|
|
7176
7324
|
"maxLength": 17,
|
|
7177
7325
|
"x-f5xc-required-for": {
|
|
@@ -7182,7 +7330,7 @@
|
|
|
7182
7330
|
},
|
|
7183
7331
|
"x-original-maxLength": 1024,
|
|
7184
7332
|
"x-reconciled-from-discovery": true,
|
|
7185
|
-
"x-reconciled-at": "2026-01-
|
|
7333
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138334+00:00"
|
|
7186
7334
|
},
|
|
7187
7335
|
"type": {
|
|
7188
7336
|
"type": "string",
|
|
@@ -7197,6 +7345,8 @@
|
|
|
7197
7345
|
"x-validation-rules": {
|
|
7198
7346
|
"ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
|
|
7199
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.",
|
|
7200
7350
|
"minLength": 0,
|
|
7201
7351
|
"maxLength": 1024,
|
|
7202
7352
|
"x-f5xc-required-for": {
|
|
@@ -7207,6 +7357,8 @@
|
|
|
7207
7357
|
}
|
|
7208
7358
|
}
|
|
7209
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.",
|
|
7210
7362
|
"x-f5xc-minimum-configuration": {
|
|
7211
7363
|
"description": "Minimum configuration for schemaConditionType",
|
|
7212
7364
|
"required_fields": [
|
|
@@ -7238,6 +7390,8 @@
|
|
|
7238
7390
|
"x-displayname": "Kind",
|
|
7239
7391
|
"x-ves-example": "Virtual_site.",
|
|
7240
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\").",
|
|
7241
7395
|
"minLength": 0,
|
|
7242
7396
|
"maxLength": 14,
|
|
7243
7397
|
"x-f5xc-required-for": {
|
|
@@ -7249,7 +7403,7 @@
|
|
|
7249
7403
|
"readOnly": true,
|
|
7250
7404
|
"x-original-maxLength": 1024,
|
|
7251
7405
|
"x-reconciled-from-discovery": true,
|
|
7252
|
-
"x-reconciled-at": "2026-01-
|
|
7406
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138392+00:00"
|
|
7253
7407
|
},
|
|
7254
7408
|
"name": {
|
|
7255
7409
|
"type": "string",
|
|
@@ -7258,6 +7412,8 @@
|
|
|
7258
7412
|
"x-displayname": "Name",
|
|
7259
7413
|
"x-ves-example": "Contactus-route.",
|
|
7260
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.",
|
|
7261
7417
|
"minLength": 0,
|
|
7262
7418
|
"maxLength": 16,
|
|
7263
7419
|
"x-f5xc-required-for": {
|
|
@@ -7268,7 +7424,7 @@
|
|
|
7268
7424
|
},
|
|
7269
7425
|
"x-original-maxLength": 1024,
|
|
7270
7426
|
"x-reconciled-from-discovery": true,
|
|
7271
|
-
"x-reconciled-at": "2026-01-
|
|
7427
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138396+00:00"
|
|
7272
7428
|
},
|
|
7273
7429
|
"namespace": {
|
|
7274
7430
|
"type": "string",
|
|
@@ -7277,6 +7433,8 @@
|
|
|
7277
7433
|
"x-displayname": "Namespace",
|
|
7278
7434
|
"x-ves-example": "Ns1",
|
|
7279
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.",
|
|
7280
7438
|
"minLength": 0,
|
|
7281
7439
|
"maxLength": 6,
|
|
7282
7440
|
"x-f5xc-required-for": {
|
|
@@ -7287,7 +7445,7 @@
|
|
|
7287
7445
|
},
|
|
7288
7446
|
"x-original-maxLength": 1024,
|
|
7289
7447
|
"x-reconciled-from-discovery": true,
|
|
7290
|
-
"x-reconciled-at": "2026-01-
|
|
7448
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138400+00:00"
|
|
7291
7449
|
},
|
|
7292
7450
|
"tenant": {
|
|
7293
7451
|
"type": "string",
|
|
@@ -7296,6 +7454,8 @@
|
|
|
7296
7454
|
"x-displayname": "Tenant",
|
|
7297
7455
|
"x-ves-example": "Example-corp.",
|
|
7298
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.",
|
|
7299
7459
|
"minLength": 0,
|
|
7300
7460
|
"maxLength": 18,
|
|
7301
7461
|
"x-f5xc-required-for": {
|
|
@@ -7308,7 +7468,7 @@
|
|
|
7308
7468
|
"x-field-mutability": "read-only",
|
|
7309
7469
|
"x-original-maxLength": 1024,
|
|
7310
7470
|
"x-reconciled-from-discovery": true,
|
|
7311
|
-
"x-reconciled-at": "2026-01-
|
|
7471
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138404+00:00"
|
|
7312
7472
|
},
|
|
7313
7473
|
"uid": {
|
|
7314
7474
|
"type": "string",
|
|
@@ -7317,6 +7477,8 @@
|
|
|
7317
7477
|
"x-displayname": "UID",
|
|
7318
7478
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
7319
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.",
|
|
7320
7482
|
"minLength": 0,
|
|
7321
7483
|
"maxLength": 36,
|
|
7322
7484
|
"x-f5xc-required-for": {
|
|
@@ -7330,9 +7492,11 @@
|
|
|
7330
7492
|
"x-original-maxLength": 1024,
|
|
7331
7493
|
"format": "uuid",
|
|
7332
7494
|
"x-reconciled-from-discovery": true,
|
|
7333
|
-
"x-reconciled-at": "2026-01-
|
|
7495
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138411+00:00"
|
|
7334
7496
|
}
|
|
7335
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...",
|
|
7336
7500
|
"x-f5xc-minimum-configuration": {
|
|
7337
7501
|
"description": "Minimum configuration for schemaObjectRefType",
|
|
7338
7502
|
"required_fields": [
|
|
@@ -7362,6 +7526,8 @@
|
|
|
7362
7526
|
"title": "Creation_timestamp.",
|
|
7363
7527
|
"format": "date-time",
|
|
7364
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.",
|
|
7365
7531
|
"minLength": 0,
|
|
7366
7532
|
"maxLength": 1024,
|
|
7367
7533
|
"x-f5xc-required-for": {
|
|
@@ -7379,6 +7545,8 @@
|
|
|
7379
7545
|
"x-displayname": "Creator Class.",
|
|
7380
7546
|
"x-ves-example": "ver.re1.int.ves.I/O.",
|
|
7381
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.",
|
|
7382
7550
|
"minLength": 0,
|
|
7383
7551
|
"maxLength": 1024,
|
|
7384
7552
|
"x-f5xc-required-for": {
|
|
@@ -7396,6 +7564,8 @@
|
|
|
7396
7564
|
"x-displayname": "Creator ID.",
|
|
7397
7565
|
"x-ves-example": "Ver-instance-1.",
|
|
7398
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.",
|
|
7399
7569
|
"minLength": 0,
|
|
7400
7570
|
"maxLength": 1024,
|
|
7401
7571
|
"x-f5xc-required-for": {
|
|
@@ -7414,6 +7584,8 @@
|
|
|
7414
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)",
|
|
7415
7585
|
"title": "Status_id",
|
|
7416
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).",
|
|
7417
7589
|
"minLength": 0,
|
|
7418
7590
|
"maxLength": 1024,
|
|
7419
7591
|
"x-f5xc-required-for": {
|
|
@@ -7431,6 +7603,7 @@
|
|
|
7431
7603
|
"x-displayname": "UID",
|
|
7432
7604
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
7433
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.",
|
|
7434
7607
|
"minLength": 0,
|
|
7435
7608
|
"maxLength": 36,
|
|
7436
7609
|
"x-f5xc-required-for": {
|
|
@@ -7443,13 +7616,14 @@
|
|
|
7443
7616
|
"x-original-maxLength": 1024,
|
|
7444
7617
|
"format": "uuid",
|
|
7445
7618
|
"x-reconciled-from-discovery": true,
|
|
7446
|
-
"x-reconciled-at": "2026-01-
|
|
7619
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138444+00:00"
|
|
7447
7620
|
},
|
|
7448
7621
|
"vtrp_id": {
|
|
7449
7622
|
"type": "string",
|
|
7450
7623
|
"description": "Origin of this status exchanged by VTRP.",
|
|
7451
7624
|
"title": "Vtrp_id",
|
|
7452
7625
|
"x-displayname": "VTRP ID",
|
|
7626
|
+
"x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
|
|
7453
7627
|
"minLength": 0,
|
|
7454
7628
|
"maxLength": 1024,
|
|
7455
7629
|
"x-f5xc-required-for": {
|
|
@@ -7466,6 +7640,7 @@
|
|
|
7466
7640
|
"title": "Vtrp_stale.",
|
|
7467
7641
|
"format": "boolean",
|
|
7468
7642
|
"x-displayname": "VTRP Stale.",
|
|
7643
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
7469
7644
|
"x-f5xc-required-for": {
|
|
7470
7645
|
"minimum_config": false,
|
|
7471
7646
|
"create": false,
|
|
@@ -7474,6 +7649,7 @@
|
|
|
7474
7649
|
}
|
|
7475
7650
|
}
|
|
7476
7651
|
},
|
|
7652
|
+
"x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
|
|
7477
7653
|
"x-f5xc-minimum-configuration": {
|
|
7478
7654
|
"description": "Minimum configuration for schemaStatusMetaType",
|
|
7479
7655
|
"required_fields": [
|
|
@@ -7504,6 +7680,8 @@
|
|
|
7504
7680
|
"default": "STATUS_DO_NOT_PUBLISH",
|
|
7505
7681
|
"x-displayname": "Status Publish Type.",
|
|
7506
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.",
|
|
7507
7685
|
"x-f5xc-minimum-configuration": {
|
|
7508
7686
|
"description": "Minimum configuration for schemaStatusPublishType",
|
|
7509
7687
|
"required_fields": [],
|
|
@@ -7597,6 +7775,8 @@
|
|
|
7597
7775
|
"ves.io.schema.rules.repeated.max_items": "1",
|
|
7598
7776
|
"ves.io.schema.rules.repeated.min_items": "1"
|
|
7599
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.",
|
|
7600
7780
|
"x-f5xc-required-for": {
|
|
7601
7781
|
"minimum_config": false,
|
|
7602
7782
|
"create": false,
|
|
@@ -7612,6 +7792,7 @@
|
|
|
7612
7792
|
"x-displayname": "Need mTLS",
|
|
7613
7793
|
"x-ves-example": "True",
|
|
7614
7794
|
"x-f5xc-example": "true",
|
|
7795
|
+
"x-f5xc-description-short": "Is mTLS required when using this APIKey?",
|
|
7615
7796
|
"x-f5xc-required-for": {
|
|
7616
7797
|
"minimum_config": false,
|
|
7617
7798
|
"create": false,
|
|
@@ -7620,6 +7801,8 @@
|
|
|
7620
7801
|
}
|
|
7621
7802
|
}
|
|
7622
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.",
|
|
7623
7806
|
"x-f5xc-minimum-configuration": {
|
|
7624
7807
|
"description": "Minimum configuration for tpm_api_keyCreateSpecType",
|
|
7625
7808
|
"required_fields": [
|
|
@@ -7651,6 +7834,7 @@
|
|
|
7651
7834
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
7652
7835
|
},
|
|
7653
7836
|
"x-displayname": "Deleted Referred Objects.",
|
|
7837
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
7654
7838
|
"x-f5xc-required-for": {
|
|
7655
7839
|
"minimum_config": false,
|
|
7656
7840
|
"create": false,
|
|
@@ -7666,6 +7850,7 @@
|
|
|
7666
7850
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
7667
7851
|
},
|
|
7668
7852
|
"x-displayname": "Disabled Referred Objects.",
|
|
7853
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
7669
7854
|
"x-f5xc-required-for": {
|
|
7670
7855
|
"minimum_config": false,
|
|
7671
7856
|
"create": false,
|
|
@@ -7684,6 +7869,7 @@
|
|
|
7684
7869
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
7685
7870
|
},
|
|
7686
7871
|
"x-displayname": "Referring Objects.",
|
|
7872
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
7687
7873
|
"x-f5xc-required-for": {
|
|
7688
7874
|
"minimum_config": false,
|
|
7689
7875
|
"create": false,
|
|
@@ -7705,6 +7891,8 @@
|
|
|
7705
7891
|
"$ref": "#/components/schemas/tpm_api_keyStatusObject"
|
|
7706
7892
|
},
|
|
7707
7893
|
"x-displayname": "Status",
|
|
7894
|
+
"x-f5xc-example": "active",
|
|
7895
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
7708
7896
|
"x-f5xc-required-for": {
|
|
7709
7897
|
"minimum_config": false,
|
|
7710
7898
|
"create": false,
|
|
@@ -7714,7 +7902,7 @@
|
|
|
7714
7902
|
"maxLength": 17,
|
|
7715
7903
|
"minLength": 17,
|
|
7716
7904
|
"x-reconciled-from-discovery": true,
|
|
7717
|
-
"x-reconciled-at": "2026-01-
|
|
7905
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138535+00:00"
|
|
7718
7906
|
},
|
|
7719
7907
|
"system_metadata": {
|
|
7720
7908
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -7754,6 +7942,8 @@
|
|
|
7754
7942
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
7755
7943
|
],
|
|
7756
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...",
|
|
7757
7947
|
"x-f5xc-minimum-configuration": {
|
|
7758
7948
|
"description": "Minimum configuration for tpm_api_keyGetResponseFormatCode",
|
|
7759
7949
|
"required_fields": [],
|
|
@@ -7792,6 +7982,8 @@
|
|
|
7792
7982
|
"ves.io.schema.rules.repeated.max_items": "1",
|
|
7793
7983
|
"ves.io.schema.rules.repeated.min_items": "1"
|
|
7794
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.",
|
|
7795
7987
|
"x-f5xc-required-for": {
|
|
7796
7988
|
"minimum_config": false,
|
|
7797
7989
|
"create": false,
|
|
@@ -7807,6 +7999,7 @@
|
|
|
7807
7999
|
"x-displayname": "Is_disabled.",
|
|
7808
8000
|
"x-ves-example": "True",
|
|
7809
8001
|
"x-f5xc-example": "true",
|
|
8002
|
+
"x-f5xc-description-short": "If true that indicates that this APIKey is disabled.",
|
|
7810
8003
|
"x-f5xc-required-for": {
|
|
7811
8004
|
"minimum_config": false,
|
|
7812
8005
|
"create": false,
|
|
@@ -7822,6 +8015,7 @@
|
|
|
7822
8015
|
"x-displayname": "Need mTLS",
|
|
7823
8016
|
"x-ves-example": "True",
|
|
7824
8017
|
"x-f5xc-example": "true",
|
|
8018
|
+
"x-f5xc-description-short": "Is mTLS required when using this APIKey?",
|
|
7825
8019
|
"x-f5xc-required-for": {
|
|
7826
8020
|
"minimum_config": false,
|
|
7827
8021
|
"create": false,
|
|
@@ -7836,6 +8030,8 @@
|
|
|
7836
8030
|
"x-displayname": "Revoke_reason.",
|
|
7837
8031
|
"x-ves-example": "Value",
|
|
7838
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.",
|
|
7839
8035
|
"minLength": 0,
|
|
7840
8036
|
"maxLength": 1024,
|
|
7841
8037
|
"x-f5xc-required-for": {
|
|
@@ -7851,6 +8047,8 @@
|
|
|
7851
8047
|
"title": "Revocation timestamp.",
|
|
7852
8048
|
"format": "date-time",
|
|
7853
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.",
|
|
7854
8052
|
"minLength": 0,
|
|
7855
8053
|
"maxLength": 1024,
|
|
7856
8054
|
"x-f5xc-required-for": {
|
|
@@ -7892,6 +8090,7 @@
|
|
|
7892
8090
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
7893
8091
|
},
|
|
7894
8092
|
"x-displayname": "Errors",
|
|
8093
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
7895
8094
|
"x-f5xc-required-for": {
|
|
7896
8095
|
"minimum_config": false,
|
|
7897
8096
|
"create": false,
|
|
@@ -7907,6 +8106,8 @@
|
|
|
7907
8106
|
"$ref": "#/components/schemas/tpm_api_keyListResponseItem"
|
|
7908
8107
|
},
|
|
7909
8108
|
"x-displayname": "Items",
|
|
8109
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
8110
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
7910
8111
|
"x-f5xc-required-for": {
|
|
7911
8112
|
"minimum_config": false,
|
|
7912
8113
|
"create": false,
|
|
@@ -7940,6 +8141,8 @@
|
|
|
7940
8141
|
"description": "The set of annotations present on this tpm_api_key.",
|
|
7941
8142
|
"title": "Annotations.",
|
|
7942
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.",
|
|
7943
8146
|
"x-f5xc-required-for": {
|
|
7944
8147
|
"minimum_config": false,
|
|
7945
8148
|
"create": false,
|
|
@@ -7952,6 +8155,7 @@
|
|
|
7952
8155
|
"description": "The description set for this tpm_api_key.",
|
|
7953
8156
|
"title": "Description.",
|
|
7954
8157
|
"x-displayname": "Description.",
|
|
8158
|
+
"x-f5xc-description-short": "The description set for this tpm_api_key.",
|
|
7955
8159
|
"minLength": 0,
|
|
7956
8160
|
"maxLength": 0,
|
|
7957
8161
|
"x-f5xc-required-for": {
|
|
@@ -7962,7 +8166,7 @@
|
|
|
7962
8166
|
},
|
|
7963
8167
|
"x-original-maxLength": 1024,
|
|
7964
8168
|
"x-reconciled-from-discovery": true,
|
|
7965
|
-
"x-reconciled-at": "2026-01-
|
|
8169
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138556+00:00"
|
|
7966
8170
|
},
|
|
7967
8171
|
"disabled": {
|
|
7968
8172
|
"type": "boolean",
|
|
@@ -7970,6 +8174,8 @@
|
|
|
7970
8174
|
"title": "Disabled",
|
|
7971
8175
|
"format": "boolean",
|
|
7972
8176
|
"x-displayname": "Disabled",
|
|
8177
|
+
"x-f5xc-example": "True",
|
|
8178
|
+
"x-f5xc-description-short": "Value of true indicates tpm_api_key is administratively disabled.",
|
|
7973
8179
|
"x-f5xc-required-for": {
|
|
7974
8180
|
"minimum_config": false,
|
|
7975
8181
|
"create": false,
|
|
@@ -7985,6 +8191,8 @@
|
|
|
7985
8191
|
"description": "The set of labels present on this tpm_api_key.",
|
|
7986
8192
|
"title": "Labels",
|
|
7987
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.",
|
|
7988
8196
|
"x-f5xc-required-for": {
|
|
7989
8197
|
"minimum_config": false,
|
|
7990
8198
|
"create": false,
|
|
@@ -8012,7 +8220,7 @@
|
|
|
8012
8220
|
},
|
|
8013
8221
|
"x-original-maxLength": 1024,
|
|
8014
8222
|
"x-reconciled-from-discovery": true,
|
|
8015
|
-
"x-reconciled-at": "2026-01-
|
|
8223
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138565+00:00"
|
|
8016
8224
|
},
|
|
8017
8225
|
"namespace": {
|
|
8018
8226
|
"type": "string",
|
|
@@ -8031,7 +8239,7 @@
|
|
|
8031
8239
|
},
|
|
8032
8240
|
"x-original-maxLength": 1024,
|
|
8033
8241
|
"x-reconciled-from-discovery": true,
|
|
8034
|
-
"x-reconciled-at": "2026-01-
|
|
8242
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138570+00:00"
|
|
8035
8243
|
},
|
|
8036
8244
|
"owner_view": {
|
|
8037
8245
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -8044,6 +8252,7 @@
|
|
|
8044
8252
|
"$ref": "#/components/schemas/tpm_api_keyStatusObject"
|
|
8045
8253
|
},
|
|
8046
8254
|
"x-displayname": "Status",
|
|
8255
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
8047
8256
|
"x-f5xc-required-for": {
|
|
8048
8257
|
"minimum_config": false,
|
|
8049
8258
|
"create": false,
|
|
@@ -8072,7 +8281,7 @@
|
|
|
8072
8281
|
"x-field-mutability": "read-only",
|
|
8073
8282
|
"x-original-maxLength": 1024,
|
|
8074
8283
|
"x-reconciled-from-discovery": true,
|
|
8075
|
-
"x-reconciled-at": "2026-01-
|
|
8284
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138577+00:00"
|
|
8076
8285
|
},
|
|
8077
8286
|
"uid": {
|
|
8078
8287
|
"type": "string",
|
|
@@ -8093,9 +8302,11 @@
|
|
|
8093
8302
|
"x-original-maxLength": 1024,
|
|
8094
8303
|
"format": "uuid",
|
|
8095
8304
|
"x-reconciled-from-discovery": true,
|
|
8096
|
-
"x-reconciled-at": "2026-01-
|
|
8305
|
+
"x-reconciled-at": "2026-01-07T15:29:30.138582+00:00"
|
|
8097
8306
|
}
|
|
8098
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.",
|
|
8099
8310
|
"x-f5xc-minimum-configuration": {
|
|
8100
8311
|
"description": "Minimum configuration for tpm_api_keyListResponseItem",
|
|
8101
8312
|
"required_fields": [
|
|
@@ -8175,6 +8386,7 @@
|
|
|
8175
8386
|
"x-displayname": "Is_disabled.",
|
|
8176
8387
|
"x-ves-example": "True",
|
|
8177
8388
|
"x-f5xc-example": "true",
|
|
8389
|
+
"x-f5xc-description-short": "If true that indicates that this APIKey is disabled.",
|
|
8178
8390
|
"x-f5xc-required-for": {
|
|
8179
8391
|
"minimum_config": false,
|
|
8180
8392
|
"create": false,
|
|
@@ -8189,6 +8401,8 @@
|
|
|
8189
8401
|
"x-displayname": "Revoke_reason.",
|
|
8190
8402
|
"x-ves-example": "Value",
|
|
8191
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.",
|
|
8192
8406
|
"minLength": 0,
|
|
8193
8407
|
"maxLength": 1024,
|
|
8194
8408
|
"x-f5xc-required-for": {
|
|
@@ -8204,6 +8418,8 @@
|
|
|
8204
8418
|
"title": "Timestamp when this apikey was revoked.",
|
|
8205
8419
|
"format": "date-time",
|
|
8206
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.",
|
|
8207
8423
|
"minLength": 0,
|
|
8208
8424
|
"maxLength": 1024,
|
|
8209
8425
|
"x-f5xc-required-for": {
|
|
@@ -8214,6 +8430,8 @@
|
|
|
8214
8430
|
}
|
|
8215
8431
|
}
|
|
8216
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...",
|
|
8217
8435
|
"x-f5xc-minimum-configuration": {
|
|
8218
8436
|
"description": "Minimum configuration for tpm_api_keyReplaceSpecType",
|
|
8219
8437
|
"required_fields": [
|
|
@@ -8244,6 +8462,7 @@
|
|
|
8244
8462
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
8245
8463
|
},
|
|
8246
8464
|
"x-displayname": "Conditions.",
|
|
8465
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
8247
8466
|
"x-f5xc-required-for": {
|
|
8248
8467
|
"minimum_config": false,
|
|
8249
8468
|
"create": false,
|
|
@@ -8270,6 +8489,7 @@
|
|
|
8270
8489
|
}
|
|
8271
8490
|
}
|
|
8272
8491
|
},
|
|
8492
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
8273
8493
|
"x-f5xc-minimum-configuration": {
|
|
8274
8494
|
"description": "Minimum configuration for tpm_api_keyStatusObject",
|
|
8275
8495
|
"required_fields": [
|
|
@@ -8356,6 +8576,8 @@
|
|
|
8356
8576
|
"x-displayname": "List of allowed TPM EK Certificates.",
|
|
8357
8577
|
"x-ves-example": "Value",
|
|
8358
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...",
|
|
8359
8581
|
"x-f5xc-required-for": {
|
|
8360
8582
|
"minimum_config": false,
|
|
8361
8583
|
"create": false,
|
|
@@ -8392,6 +8614,7 @@
|
|
|
8392
8614
|
}
|
|
8393
8615
|
}
|
|
8394
8616
|
},
|
|
8617
|
+
"x-f5xc-description-short": "Create a Category object, which is a grouping of APIKeys used for TPM provisioning.",
|
|
8395
8618
|
"x-f5xc-minimum-configuration": {
|
|
8396
8619
|
"description": "Minimum configuration for tpm_categoryCreateSpecType",
|
|
8397
8620
|
"required_fields": [
|
|
@@ -8423,6 +8646,7 @@
|
|
|
8423
8646
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
8424
8647
|
},
|
|
8425
8648
|
"x-displayname": "Deleted Referred Objects.",
|
|
8649
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
8426
8650
|
"x-f5xc-required-for": {
|
|
8427
8651
|
"minimum_config": false,
|
|
8428
8652
|
"create": false,
|
|
@@ -8438,6 +8662,7 @@
|
|
|
8438
8662
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
8439
8663
|
},
|
|
8440
8664
|
"x-displayname": "Disabled Referred Objects.",
|
|
8665
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
8441
8666
|
"x-f5xc-required-for": {
|
|
8442
8667
|
"minimum_config": false,
|
|
8443
8668
|
"create": false,
|
|
@@ -8456,6 +8681,7 @@
|
|
|
8456
8681
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
8457
8682
|
},
|
|
8458
8683
|
"x-displayname": "Referring Objects.",
|
|
8684
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
8459
8685
|
"x-f5xc-required-for": {
|
|
8460
8686
|
"minimum_config": false,
|
|
8461
8687
|
"create": false,
|
|
@@ -8477,6 +8703,8 @@
|
|
|
8477
8703
|
"$ref": "#/components/schemas/tpm_categoryStatusObject"
|
|
8478
8704
|
},
|
|
8479
8705
|
"x-displayname": "Status",
|
|
8706
|
+
"x-f5xc-example": "active",
|
|
8707
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
8480
8708
|
"x-f5xc-required-for": {
|
|
8481
8709
|
"minimum_config": false,
|
|
8482
8710
|
"create": false,
|
|
@@ -8486,7 +8714,7 @@
|
|
|
8486
8714
|
"maxLength": 17,
|
|
8487
8715
|
"minLength": 17,
|
|
8488
8716
|
"x-reconciled-from-discovery": true,
|
|
8489
|
-
"x-reconciled-at": "2026-01-
|
|
8717
|
+
"x-reconciled-at": "2026-01-07T15:29:30.553246+00:00"
|
|
8490
8718
|
},
|
|
8491
8719
|
"system_metadata": {
|
|
8492
8720
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -8526,6 +8754,8 @@
|
|
|
8526
8754
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
8527
8755
|
],
|
|
8528
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...",
|
|
8529
8759
|
"x-f5xc-minimum-configuration": {
|
|
8530
8760
|
"description": "Minimum configuration for tpm_categoryGetResponseFormatCode",
|
|
8531
8761
|
"required_fields": [],
|
|
@@ -8550,6 +8780,7 @@
|
|
|
8550
8780
|
"x-displayname": "AK Sub CA Certificate.",
|
|
8551
8781
|
"x-ves-example": "Value",
|
|
8552
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.",
|
|
8553
8784
|
"minLength": 0,
|
|
8554
8785
|
"maxLength": 1024,
|
|
8555
8786
|
"x-f5xc-required-for": {
|
|
@@ -8566,6 +8797,7 @@
|
|
|
8566
8797
|
"x-displayname": "AK_SUB_CA_NAME.",
|
|
8567
8798
|
"x-ves-example": "Value",
|
|
8568
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.",
|
|
8569
8801
|
"minLength": 0,
|
|
8570
8802
|
"maxLength": 1024,
|
|
8571
8803
|
"x-f5xc-required-for": {
|
|
@@ -8582,6 +8814,7 @@
|
|
|
8582
8814
|
"x-displayname": "Client certificate.",
|
|
8583
8815
|
"x-ves-example": "Value",
|
|
8584
8816
|
"x-f5xc-example": "value",
|
|
8817
|
+
"x-f5xc-description-short": "PEM formatted Client certificate for mTLS.",
|
|
8585
8818
|
"minLength": 0,
|
|
8586
8819
|
"maxLength": 1024,
|
|
8587
8820
|
"x-f5xc-required-for": {
|
|
@@ -8598,6 +8831,7 @@
|
|
|
8598
8831
|
"x-displayname": "ClientKey",
|
|
8599
8832
|
"x-ves-example": "Value",
|
|
8600
8833
|
"x-f5xc-example": "value",
|
|
8834
|
+
"x-f5xc-description-short": "Client Key for mTLS to be used with ClientCert.",
|
|
8601
8835
|
"minLength": 0,
|
|
8602
8836
|
"maxLength": 1024,
|
|
8603
8837
|
"x-f5xc-required-for": {
|
|
@@ -8617,6 +8851,8 @@
|
|
|
8617
8851
|
"x-displayname": "List of allowed TPM EK Certificates.",
|
|
8618
8852
|
"x-ves-example": "Value",
|
|
8619
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...",
|
|
8620
8856
|
"x-f5xc-required-for": {
|
|
8621
8857
|
"minimum_config": false,
|
|
8622
8858
|
"create": false,
|
|
@@ -8685,6 +8921,7 @@
|
|
|
8685
8921
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
8686
8922
|
},
|
|
8687
8923
|
"x-displayname": "Errors",
|
|
8924
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
8688
8925
|
"x-f5xc-required-for": {
|
|
8689
8926
|
"minimum_config": false,
|
|
8690
8927
|
"create": false,
|
|
@@ -8700,6 +8937,8 @@
|
|
|
8700
8937
|
"$ref": "#/components/schemas/tpm_categoryListResponseItem"
|
|
8701
8938
|
},
|
|
8702
8939
|
"x-displayname": "Items",
|
|
8940
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
8941
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
8703
8942
|
"x-f5xc-required-for": {
|
|
8704
8943
|
"minimum_config": false,
|
|
8705
8944
|
"create": false,
|
|
@@ -8733,6 +8972,8 @@
|
|
|
8733
8972
|
"description": "The set of annotations present on this tpm_category.",
|
|
8734
8973
|
"title": "Annotations.",
|
|
8735
8974
|
"x-displayname": "Annotations.",
|
|
8975
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
8976
|
+
"x-f5xc-description-short": "The set of annotations present on this tpm_category.",
|
|
8736
8977
|
"x-f5xc-required-for": {
|
|
8737
8978
|
"minimum_config": false,
|
|
8738
8979
|
"create": false,
|
|
@@ -8745,6 +8986,7 @@
|
|
|
8745
8986
|
"description": "The description set for this tpm_category.",
|
|
8746
8987
|
"title": "Description.",
|
|
8747
8988
|
"x-displayname": "Description.",
|
|
8989
|
+
"x-f5xc-description-short": "The description set for this tpm_category.",
|
|
8748
8990
|
"minLength": 0,
|
|
8749
8991
|
"maxLength": 0,
|
|
8750
8992
|
"x-f5xc-required-for": {
|
|
@@ -8755,7 +8997,7 @@
|
|
|
8755
8997
|
},
|
|
8756
8998
|
"x-original-maxLength": 1024,
|
|
8757
8999
|
"x-reconciled-from-discovery": true,
|
|
8758
|
-
"x-reconciled-at": "2026-01-
|
|
9000
|
+
"x-reconciled-at": "2026-01-07T15:29:30.553267+00:00"
|
|
8759
9001
|
},
|
|
8760
9002
|
"disabled": {
|
|
8761
9003
|
"type": "boolean",
|
|
@@ -8763,6 +9005,8 @@
|
|
|
8763
9005
|
"title": "Disabled",
|
|
8764
9006
|
"format": "boolean",
|
|
8765
9007
|
"x-displayname": "Disabled",
|
|
9008
|
+
"x-f5xc-example": "True",
|
|
9009
|
+
"x-f5xc-description-short": "Value of true indicates tpm_category is administratively disabled.",
|
|
8766
9010
|
"x-f5xc-required-for": {
|
|
8767
9011
|
"minimum_config": false,
|
|
8768
9012
|
"create": false,
|
|
@@ -8778,6 +9022,8 @@
|
|
|
8778
9022
|
"description": "The set of labels present on this tpm_category.",
|
|
8779
9023
|
"title": "Labels",
|
|
8780
9024
|
"x-displayname": "Labels",
|
|
9025
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
9026
|
+
"x-f5xc-description-short": "The set of labels present on this tpm_category.",
|
|
8781
9027
|
"x-f5xc-required-for": {
|
|
8782
9028
|
"minimum_config": false,
|
|
8783
9029
|
"create": false,
|
|
@@ -8805,7 +9051,7 @@
|
|
|
8805
9051
|
},
|
|
8806
9052
|
"x-original-maxLength": 1024,
|
|
8807
9053
|
"x-reconciled-from-discovery": true,
|
|
8808
|
-
"x-reconciled-at": "2026-01-
|
|
9054
|
+
"x-reconciled-at": "2026-01-07T15:29:30.553277+00:00"
|
|
8809
9055
|
},
|
|
8810
9056
|
"namespace": {
|
|
8811
9057
|
"type": "string",
|
|
@@ -8824,7 +9070,7 @@
|
|
|
8824
9070
|
},
|
|
8825
9071
|
"x-original-maxLength": 1024,
|
|
8826
9072
|
"x-reconciled-from-discovery": true,
|
|
8827
|
-
"x-reconciled-at": "2026-01-
|
|
9073
|
+
"x-reconciled-at": "2026-01-07T15:29:30.553281+00:00"
|
|
8828
9074
|
},
|
|
8829
9075
|
"owner_view": {
|
|
8830
9076
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -8837,6 +9083,7 @@
|
|
|
8837
9083
|
"$ref": "#/components/schemas/tpm_categoryStatusObject"
|
|
8838
9084
|
},
|
|
8839
9085
|
"x-displayname": "Status",
|
|
9086
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
8840
9087
|
"x-f5xc-required-for": {
|
|
8841
9088
|
"minimum_config": false,
|
|
8842
9089
|
"create": false,
|
|
@@ -8865,7 +9112,7 @@
|
|
|
8865
9112
|
"x-field-mutability": "read-only",
|
|
8866
9113
|
"x-original-maxLength": 1024,
|
|
8867
9114
|
"x-reconciled-from-discovery": true,
|
|
8868
|
-
"x-reconciled-at": "2026-01-
|
|
9115
|
+
"x-reconciled-at": "2026-01-07T15:29:30.553289+00:00"
|
|
8869
9116
|
},
|
|
8870
9117
|
"uid": {
|
|
8871
9118
|
"type": "string",
|
|
@@ -8886,9 +9133,11 @@
|
|
|
8886
9133
|
"x-original-maxLength": 1024,
|
|
8887
9134
|
"format": "uuid",
|
|
8888
9135
|
"x-reconciled-from-discovery": true,
|
|
8889
|
-
"x-reconciled-at": "2026-01-
|
|
9136
|
+
"x-reconciled-at": "2026-01-07T15:29:30.553294+00:00"
|
|
8890
9137
|
}
|
|
8891
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.",
|
|
8892
9141
|
"x-f5xc-minimum-configuration": {
|
|
8893
9142
|
"description": "Minimum configuration for tpm_categoryListResponseItem",
|
|
8894
9143
|
"required_fields": [
|
|
@@ -8970,6 +9219,8 @@
|
|
|
8970
9219
|
"x-displayname": "List of allowed TPM EK Certificates.",
|
|
8971
9220
|
"x-ves-example": "Value",
|
|
8972
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...",
|
|
8973
9224
|
"x-f5xc-required-for": {
|
|
8974
9225
|
"minimum_config": false,
|
|
8975
9226
|
"create": false,
|
|
@@ -8978,6 +9229,7 @@
|
|
|
8978
9229
|
}
|
|
8979
9230
|
}
|
|
8980
9231
|
},
|
|
9232
|
+
"x-f5xc-description-short": "Replace a Category object's Allow list of TPM EK Certificates.",
|
|
8981
9233
|
"x-f5xc-minimum-configuration": {
|
|
8982
9234
|
"description": "Minimum configuration for tpm_categoryReplaceSpecType",
|
|
8983
9235
|
"required_fields": [
|
|
@@ -9006,6 +9258,7 @@
|
|
|
9006
9258
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
9007
9259
|
},
|
|
9008
9260
|
"x-displayname": "Conditions.",
|
|
9261
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
9009
9262
|
"x-f5xc-required-for": {
|
|
9010
9263
|
"minimum_config": false,
|
|
9011
9264
|
"create": false,
|
|
@@ -9032,6 +9285,7 @@
|
|
|
9032
9285
|
}
|
|
9033
9286
|
}
|
|
9034
9287
|
},
|
|
9288
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
9035
9289
|
"x-f5xc-minimum-configuration": {
|
|
9036
9290
|
"description": "Minimum configuration for tpm_categoryStatusObject",
|
|
9037
9291
|
"required_fields": [
|
|
@@ -9135,6 +9389,7 @@
|
|
|
9135
9389
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
9136
9390
|
},
|
|
9137
9391
|
"x-displayname": "Deleted Referred Objects.",
|
|
9392
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
9138
9393
|
"x-f5xc-required-for": {
|
|
9139
9394
|
"minimum_config": false,
|
|
9140
9395
|
"create": false,
|
|
@@ -9150,6 +9405,7 @@
|
|
|
9150
9405
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
9151
9406
|
},
|
|
9152
9407
|
"x-displayname": "Disabled Referred Objects.",
|
|
9408
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
9153
9409
|
"x-f5xc-required-for": {
|
|
9154
9410
|
"minimum_config": false,
|
|
9155
9411
|
"create": false,
|
|
@@ -9168,6 +9424,7 @@
|
|
|
9168
9424
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
9169
9425
|
},
|
|
9170
9426
|
"x-displayname": "Referring Objects.",
|
|
9427
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
9171
9428
|
"x-f5xc-required-for": {
|
|
9172
9429
|
"minimum_config": false,
|
|
9173
9430
|
"create": false,
|
|
@@ -9186,6 +9443,8 @@
|
|
|
9186
9443
|
"$ref": "#/components/schemas/tpm_managerStatusObject"
|
|
9187
9444
|
},
|
|
9188
9445
|
"x-displayname": "Status",
|
|
9446
|
+
"x-f5xc-example": "active",
|
|
9447
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
9189
9448
|
"x-f5xc-required-for": {
|
|
9190
9449
|
"minimum_config": false,
|
|
9191
9450
|
"create": false,
|
|
@@ -9195,7 +9454,7 @@
|
|
|
9195
9454
|
"maxLength": 17,
|
|
9196
9455
|
"minLength": 17,
|
|
9197
9456
|
"x-reconciled-from-discovery": true,
|
|
9198
|
-
"x-reconciled-at": "2026-01-
|
|
9457
|
+
"x-reconciled-at": "2026-01-07T15:29:30.934209+00:00"
|
|
9199
9458
|
},
|
|
9200
9459
|
"system_metadata": {
|
|
9201
9460
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -9233,6 +9492,8 @@
|
|
|
9233
9492
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
9234
9493
|
],
|
|
9235
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...",
|
|
9236
9497
|
"x-f5xc-minimum-configuration": {
|
|
9237
9498
|
"description": "Minimum configuration for tpm_managerGetResponseFormatCode",
|
|
9238
9499
|
"required_fields": [],
|
|
@@ -9273,6 +9534,8 @@
|
|
|
9273
9534
|
"x-displayname": "AK(Attestation Key) Root CA Name.",
|
|
9274
9535
|
"x-ves-example": "Value",
|
|
9275
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.",
|
|
9276
9539
|
"minLength": 0,
|
|
9277
9540
|
"maxLength": 1024,
|
|
9278
9541
|
"x-f5xc-required-for": {
|
|
@@ -9311,6 +9574,7 @@
|
|
|
9311
9574
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
9312
9575
|
},
|
|
9313
9576
|
"x-displayname": "Errors",
|
|
9577
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
9314
9578
|
"x-f5xc-required-for": {
|
|
9315
9579
|
"minimum_config": false,
|
|
9316
9580
|
"create": false,
|
|
@@ -9326,6 +9590,8 @@
|
|
|
9326
9590
|
"$ref": "#/components/schemas/tpm_managerListResponseItem"
|
|
9327
9591
|
},
|
|
9328
9592
|
"x-displayname": "Items",
|
|
9593
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
9594
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
9329
9595
|
"x-f5xc-required-for": {
|
|
9330
9596
|
"minimum_config": false,
|
|
9331
9597
|
"create": false,
|
|
@@ -9359,6 +9625,8 @@
|
|
|
9359
9625
|
"description": "The set of annotations present on this tpm_manager.",
|
|
9360
9626
|
"title": "Annotations.",
|
|
9361
9627
|
"x-displayname": "Annotations.",
|
|
9628
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
9629
|
+
"x-f5xc-description-short": "The set of annotations present on this tpm_manager.",
|
|
9362
9630
|
"x-f5xc-required-for": {
|
|
9363
9631
|
"minimum_config": false,
|
|
9364
9632
|
"create": false,
|
|
@@ -9371,6 +9639,7 @@
|
|
|
9371
9639
|
"description": "The description set for this tpm_manager.",
|
|
9372
9640
|
"title": "Description.",
|
|
9373
9641
|
"x-displayname": "Description.",
|
|
9642
|
+
"x-f5xc-description-short": "The description set for this tpm_manager.",
|
|
9374
9643
|
"minLength": 0,
|
|
9375
9644
|
"maxLength": 0,
|
|
9376
9645
|
"x-f5xc-required-for": {
|
|
@@ -9381,7 +9650,7 @@
|
|
|
9381
9650
|
},
|
|
9382
9651
|
"x-original-maxLength": 1024,
|
|
9383
9652
|
"x-reconciled-from-discovery": true,
|
|
9384
|
-
"x-reconciled-at": "2026-01-
|
|
9653
|
+
"x-reconciled-at": "2026-01-07T15:29:30.934224+00:00"
|
|
9385
9654
|
},
|
|
9386
9655
|
"disabled": {
|
|
9387
9656
|
"type": "boolean",
|
|
@@ -9389,6 +9658,8 @@
|
|
|
9389
9658
|
"title": "Disabled",
|
|
9390
9659
|
"format": "boolean",
|
|
9391
9660
|
"x-displayname": "Disabled",
|
|
9661
|
+
"x-f5xc-example": "True",
|
|
9662
|
+
"x-f5xc-description-short": "Value of true indicates tpm_manager is administratively disabled.",
|
|
9392
9663
|
"x-f5xc-required-for": {
|
|
9393
9664
|
"minimum_config": false,
|
|
9394
9665
|
"create": false,
|
|
@@ -9404,6 +9675,8 @@
|
|
|
9404
9675
|
"description": "The set of labels present on this tpm_manager.",
|
|
9405
9676
|
"title": "Labels",
|
|
9406
9677
|
"x-displayname": "Labels",
|
|
9678
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
9679
|
+
"x-f5xc-description-short": "The set of labels present on this tpm_manager.",
|
|
9407
9680
|
"x-f5xc-required-for": {
|
|
9408
9681
|
"minimum_config": false,
|
|
9409
9682
|
"create": false,
|
|
@@ -9431,7 +9704,7 @@
|
|
|
9431
9704
|
},
|
|
9432
9705
|
"x-original-maxLength": 1024,
|
|
9433
9706
|
"x-reconciled-from-discovery": true,
|
|
9434
|
-
"x-reconciled-at": "2026-01-
|
|
9707
|
+
"x-reconciled-at": "2026-01-07T15:29:30.934234+00:00"
|
|
9435
9708
|
},
|
|
9436
9709
|
"namespace": {
|
|
9437
9710
|
"type": "string",
|
|
@@ -9450,7 +9723,7 @@
|
|
|
9450
9723
|
},
|
|
9451
9724
|
"x-original-maxLength": 1024,
|
|
9452
9725
|
"x-reconciled-from-discovery": true,
|
|
9453
|
-
"x-reconciled-at": "2026-01-
|
|
9726
|
+
"x-reconciled-at": "2026-01-07T15:29:30.934238+00:00"
|
|
9454
9727
|
},
|
|
9455
9728
|
"owner_view": {
|
|
9456
9729
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -9463,6 +9736,7 @@
|
|
|
9463
9736
|
"$ref": "#/components/schemas/tpm_managerStatusObject"
|
|
9464
9737
|
},
|
|
9465
9738
|
"x-displayname": "Status",
|
|
9739
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
9466
9740
|
"x-f5xc-required-for": {
|
|
9467
9741
|
"minimum_config": false,
|
|
9468
9742
|
"create": false,
|
|
@@ -9491,7 +9765,7 @@
|
|
|
9491
9765
|
"x-field-mutability": "read-only",
|
|
9492
9766
|
"x-original-maxLength": 1024,
|
|
9493
9767
|
"x-reconciled-from-discovery": true,
|
|
9494
|
-
"x-reconciled-at": "2026-01-
|
|
9768
|
+
"x-reconciled-at": "2026-01-07T15:29:30.934246+00:00"
|
|
9495
9769
|
},
|
|
9496
9770
|
"uid": {
|
|
9497
9771
|
"type": "string",
|
|
@@ -9512,9 +9786,11 @@
|
|
|
9512
9786
|
"x-original-maxLength": 1024,
|
|
9513
9787
|
"format": "uuid",
|
|
9514
9788
|
"x-reconciled-from-discovery": true,
|
|
9515
|
-
"x-reconciled-at": "2026-01-
|
|
9789
|
+
"x-reconciled-at": "2026-01-07T15:29:30.934251+00:00"
|
|
9516
9790
|
}
|
|
9517
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.",
|
|
9518
9794
|
"x-f5xc-minimum-configuration": {
|
|
9519
9795
|
"description": "Minimum configuration for tpm_managerListResponseItem",
|
|
9520
9796
|
"required_fields": [
|
|
@@ -9555,6 +9831,7 @@
|
|
|
9555
9831
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
9556
9832
|
},
|
|
9557
9833
|
"x-displayname": "Conditions.",
|
|
9834
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
9558
9835
|
"x-f5xc-required-for": {
|
|
9559
9836
|
"minimum_config": false,
|
|
9560
9837
|
"create": false,
|
|
@@ -9581,6 +9858,7 @@
|
|
|
9581
9858
|
}
|
|
9582
9859
|
}
|
|
9583
9860
|
},
|
|
9861
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
9584
9862
|
"x-f5xc-minimum-configuration": {
|
|
9585
9863
|
"description": "Minimum configuration for tpm_managerStatusObject",
|
|
9586
9864
|
"required_fields": [
|
|
@@ -9626,7 +9904,7 @@
|
|
|
9626
9904
|
},
|
|
9627
9905
|
"x-original-maxLength": 1024,
|
|
9628
9906
|
"x-reconciled-from-discovery": true,
|
|
9629
|
-
"x-reconciled-at": "2026-01-
|
|
9907
|
+
"x-reconciled-at": "2026-01-07T15:29:31.188629+00:00"
|
|
9630
9908
|
},
|
|
9631
9909
|
"serial": {
|
|
9632
9910
|
"type": "string",
|
|
@@ -9698,9 +9976,10 @@
|
|
|
9698
9976
|
},
|
|
9699
9977
|
"x-original-maxLength": 1024,
|
|
9700
9978
|
"x-reconciled-from-discovery": true,
|
|
9701
|
-
"x-reconciled-at": "2026-01-
|
|
9979
|
+
"x-reconciled-at": "2026-01-07T15:29:31.188640+00:00"
|
|
9702
9980
|
}
|
|
9703
9981
|
},
|
|
9982
|
+
"x-f5xc-description-short": "DeviceInfo defines device parameters like Serial-Number to include in the TPM provisioning data.",
|
|
9704
9983
|
"x-f5xc-minimum-configuration": {
|
|
9705
9984
|
"description": "Minimum configuration for tpm_provisionDeviceInfo",
|
|
9706
9985
|
"required_fields": [
|
|
@@ -9737,6 +10016,7 @@
|
|
|
9737
10016
|
"x-validation-rules": {
|
|
9738
10017
|
"ves.io.schema.rules.message.required": "true"
|
|
9739
10018
|
},
|
|
10019
|
+
"x-f5xc-description-short": "API Key allocated to TPM Provisioning (manufacturing) user Required: YES.",
|
|
9740
10020
|
"minLength": 0,
|
|
9741
10021
|
"maxLength": 1024,
|
|
9742
10022
|
"x-f5xc-required-for": {
|
|
@@ -9750,6 +10030,8 @@
|
|
|
9750
10030
|
"$ref": "#/components/schemas/tpm_provisionDeviceInfo"
|
|
9751
10031
|
}
|
|
9752
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.",
|
|
9753
10035
|
"x-f5xc-minimum-configuration": {
|
|
9754
10036
|
"description": "Minimum configuration for tpm_provisionPreauthRequest",
|
|
9755
10037
|
"required_fields": [
|
|
@@ -9774,6 +10056,7 @@
|
|
|
9774
10056
|
"$ref": "#/components/schemas/tpm_provisionPreauthResponseStatus"
|
|
9775
10057
|
}
|
|
9776
10058
|
},
|
|
10059
|
+
"x-f5xc-description-short": "PreauthResponse defines the preauthorization response.",
|
|
9777
10060
|
"x-f5xc-minimum-configuration": {
|
|
9778
10061
|
"description": "Minimum configuration for tpm_provisionPreauthResponse",
|
|
9779
10062
|
"required_fields": [
|
|
@@ -9798,6 +10081,8 @@
|
|
|
9798
10081
|
"default": "PREAUTH_RSP_SUCCESS",
|
|
9799
10082
|
"x-displayname": "Preauth Response Status.",
|
|
9800
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.",
|
|
9801
10086
|
"x-f5xc-minimum-configuration": {
|
|
9802
10087
|
"description": "Minimum configuration for tpm_provisionPreauthResponseStatus",
|
|
9803
10088
|
"required_fields": [],
|
|
@@ -9829,6 +10114,7 @@
|
|
|
9829
10114
|
"x-validation-rules": {
|
|
9830
10115
|
"ves.io.schema.rules.message.required": "true"
|
|
9831
10116
|
},
|
|
10117
|
+
"x-f5xc-description-short": "TPM AK Public Key in DER format Required: YES.",
|
|
9832
10118
|
"minLength": 0,
|
|
9833
10119
|
"maxLength": 1024,
|
|
9834
10120
|
"x-f5xc-required-for": {
|
|
@@ -9852,6 +10138,7 @@
|
|
|
9852
10138
|
"x-validation-rules": {
|
|
9853
10139
|
"ves.io.schema.rules.message.required": "true"
|
|
9854
10140
|
},
|
|
10141
|
+
"x-f5xc-description-short": "API Key allocated to TPM Provisioning (manufacturing) user Required: YES.",
|
|
9855
10142
|
"minLength": 0,
|
|
9856
10143
|
"maxLength": 1024,
|
|
9857
10144
|
"x-f5xc-required-for": {
|
|
@@ -9875,6 +10162,7 @@
|
|
|
9875
10162
|
"x-validation-rules": {
|
|
9876
10163
|
"ves.io.schema.rules.message.required": "true"
|
|
9877
10164
|
},
|
|
10165
|
+
"x-f5xc-description-short": "Signing request from the manufacturing plant for device TPM provisioning Required: YES.",
|
|
9878
10166
|
"minLength": 0,
|
|
9879
10167
|
"maxLength": 1024,
|
|
9880
10168
|
"x-f5xc-required-for": {
|
|
@@ -9901,6 +10189,7 @@
|
|
|
9901
10189
|
"x-validation-rules": {
|
|
9902
10190
|
"ves.io.schema.rules.message.required": "true"
|
|
9903
10191
|
},
|
|
10192
|
+
"x-f5xc-description-short": "TPM EK Certificate in DER format Required: YES.",
|
|
9904
10193
|
"minLength": 0,
|
|
9905
10194
|
"maxLength": 1024,
|
|
9906
10195
|
"x-f5xc-required-for": {
|
|
@@ -9924,6 +10213,7 @@
|
|
|
9924
10213
|
"x-validation-rules": {
|
|
9925
10214
|
"ves.io.schema.rules.message.required": "true"
|
|
9926
10215
|
},
|
|
10216
|
+
"x-f5xc-description-short": "TPM EK Public Key in DER format Required: YES.",
|
|
9927
10217
|
"minLength": 0,
|
|
9928
10218
|
"maxLength": 1024,
|
|
9929
10219
|
"x-f5xc-required-for": {
|
|
@@ -9934,6 +10224,7 @@
|
|
|
9934
10224
|
}
|
|
9935
10225
|
}
|
|
9936
10226
|
},
|
|
10227
|
+
"x-f5xc-description-short": "ProvisionReq defines parameters required for TPM Provisioning Request API.",
|
|
9937
10228
|
"x-f5xc-minimum-configuration": {
|
|
9938
10229
|
"description": "Minimum configuration for tpm_provisionProvisionRequest",
|
|
9939
10230
|
"required_fields": [
|
|
@@ -9964,6 +10255,7 @@
|
|
|
9964
10255
|
"x-displayname": "TPM Credential Bundle.",
|
|
9965
10256
|
"x-ves-example": "Value",
|
|
9966
10257
|
"x-f5xc-example": "value",
|
|
10258
|
+
"x-f5xc-description-short": "TPM Credential bundle used to decrypt the encrypted AK certificate.",
|
|
9967
10259
|
"minLength": 0,
|
|
9968
10260
|
"maxLength": 1024,
|
|
9969
10261
|
"x-f5xc-required-for": {
|
|
@@ -9980,6 +10272,7 @@
|
|
|
9980
10272
|
"x-displayname": "TPM AK Certificate.",
|
|
9981
10273
|
"x-ves-example": "Value",
|
|
9982
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.",
|
|
9983
10276
|
"minLength": 0,
|
|
9984
10277
|
"maxLength": 1024,
|
|
9985
10278
|
"x-f5xc-required-for": {
|
|
@@ -9996,6 +10289,7 @@
|
|
|
9996
10289
|
"x-displayname": "TPM Encryption Nonce.",
|
|
9997
10290
|
"x-ves-example": "Value",
|
|
9998
10291
|
"x-f5xc-example": "value",
|
|
10292
|
+
"x-f5xc-description-short": "Nonce used to encrypt the AK certificate.",
|
|
9999
10293
|
"minLength": 0,
|
|
10000
10294
|
"maxLength": 1024,
|
|
10001
10295
|
"x-f5xc-required-for": {
|