@robinmordasiewicz/f5xc-api-mcp 2.0.13-2601051957 → 2.0.20-2601072244
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/README.md +23 -0
- package/dist/config/paths.d.ts.map +1 -1
- package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
- package/dist/tools/generated/ce_management/index.js +179 -1582
- package/dist/tools/generated/ce_management/index.js.map +1 -1
- package/dist/tools/generated/dependency-graph.json +2 -265
- package/dist/version.d.ts +2 -2
- package/dist/version.js +2 -2
- package/manifest.json +1 -1
- package/package.json +1 -1
- package/specs/domains/admin_console_and_ui.json +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
package/specs/domains/bigip.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Bigip",
|
|
5
5
|
"description": "On-premises appliance connector enabling iRule lifecycle operations and data group replication. APM policy coordination, virtual server configuration binding, and CNE linkage. Telemetry aggregation and health status monitoring across hybrid infrastructure deployments.",
|
|
6
|
-
"version": "2.0.
|
|
6
|
+
"version": "2.0.20",
|
|
7
7
|
"contact": {
|
|
8
8
|
"name": "F5 Distributed Cloud",
|
|
9
9
|
"url": "https://docs.cloud.f5.com"
|
|
@@ -5861,6 +5861,8 @@
|
|
|
5861
5861
|
"ves.io.schema.rules.map.max_pairs": "5",
|
|
5862
5862
|
"ves.io.schema.rules.map.values.string.max_len": "255"
|
|
5863
5863
|
},
|
|
5864
|
+
"x-f5xc-description-short": "AWS Tags is a label consisting of a user-defined key and value.",
|
|
5865
|
+
"x-f5xc-description-medium": "AWS Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in AWS console.",
|
|
5864
5866
|
"x-f5xc-required-for": {
|
|
5865
5867
|
"minimum_config": false,
|
|
5866
5868
|
"create": false,
|
|
@@ -5869,6 +5871,7 @@
|
|
|
5869
5871
|
}
|
|
5870
5872
|
}
|
|
5871
5873
|
},
|
|
5874
|
+
"x-f5xc-description-short": "Virtual F5 BIG-IP specification for AWS TGW Site.",
|
|
5872
5875
|
"x-f5xc-minimum-configuration": {
|
|
5873
5876
|
"description": "Minimum configuration for apmAPMBigIpAWSReplaceType",
|
|
5874
5877
|
"required_fields": [
|
|
@@ -5909,6 +5912,7 @@
|
|
|
5909
5912
|
"ves.io.schema.rules.message.required": "true",
|
|
5910
5913
|
"ves.io.schema.rules.string.max_len": "256"
|
|
5911
5914
|
},
|
|
5915
|
+
"x-f5xc-description-short": "Admin Username for BIG-IP Required: YES.",
|
|
5912
5916
|
"minLength": 0,
|
|
5913
5917
|
"x-f5xc-required-for": {
|
|
5914
5918
|
"minimum_config": false,
|
|
@@ -5944,6 +5948,7 @@
|
|
|
5944
5948
|
"ves.io.schema.rules.repeated.max_items": "2",
|
|
5945
5949
|
"ves.io.schema.rules.repeated.min_items": "1"
|
|
5946
5950
|
},
|
|
5951
|
+
"x-f5xc-description-short": "Specify how and where the service nodes are spawned Required: YES.",
|
|
5947
5952
|
"x-f5xc-required-for": {
|
|
5948
5953
|
"minimum_config": false,
|
|
5949
5954
|
"create": false,
|
|
@@ -5971,6 +5976,7 @@
|
|
|
5971
5976
|
"ves.io.schema.rules.string.max_len": "8192",
|
|
5972
5977
|
"ves.io.schema.rules.string.min_len": "1"
|
|
5973
5978
|
},
|
|
5979
|
+
"x-f5xc-description-short": "Public SSH key for accessing the BIG-IP nodes. Required: YES.",
|
|
5974
5980
|
"x-f5xc-required-for": {
|
|
5975
5981
|
"minimum_config": false,
|
|
5976
5982
|
"create": false,
|
|
@@ -5995,6 +6001,8 @@
|
|
|
5995
6001
|
"ves.io.schema.rules.map.max_pairs": "5",
|
|
5996
6002
|
"ves.io.schema.rules.map.values.string.max_len": "255"
|
|
5997
6003
|
},
|
|
6004
|
+
"x-f5xc-description-short": "AWS Tags is a label consisting of a user-defined key and value.",
|
|
6005
|
+
"x-f5xc-description-medium": "AWS Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in AWS console.",
|
|
5998
6006
|
"x-f5xc-required-for": {
|
|
5999
6007
|
"minimum_config": false,
|
|
6000
6008
|
"create": false,
|
|
@@ -6003,6 +6011,7 @@
|
|
|
6003
6011
|
}
|
|
6004
6012
|
}
|
|
6005
6013
|
},
|
|
6014
|
+
"x-f5xc-description-short": "Virtual F5 BIG-IP configuration for AWS TGW Site using BIG-IP APM service.",
|
|
6006
6015
|
"x-f5xc-minimum-configuration": {
|
|
6007
6016
|
"description": "Minimum configuration for apmAPMBigIpAWSType",
|
|
6008
6017
|
"required_fields": [
|
|
@@ -6036,6 +6045,7 @@
|
|
|
6036
6045
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
6037
6046
|
}
|
|
6038
6047
|
},
|
|
6048
|
+
"x-f5xc-description-short": "Select the flavor of BIG-IP AWS Marketplace to launch the instance on AWS TGW Site.",
|
|
6039
6049
|
"x-f5xc-minimum-configuration": {
|
|
6040
6050
|
"description": "Minimum configuration for apmAWSMarketPlaceImageTypeAPMaaS",
|
|
6041
6051
|
"required_fields": [
|
|
@@ -6064,6 +6074,7 @@
|
|
|
6064
6074
|
"$ref": "#/components/schemas/apmAWSMarketPlaceImageTypeAPMaaS"
|
|
6065
6075
|
}
|
|
6066
6076
|
},
|
|
6077
|
+
"x-f5xc-description-short": "Virtual F5 BIG-IP APM service to be deployed as external service on AWS Transit Gateway Site.",
|
|
6067
6078
|
"x-f5xc-minimum-configuration": {
|
|
6068
6079
|
"description": "Minimum configuration for apmAWSSiteTypeChoice",
|
|
6069
6080
|
"required_fields": [
|
|
@@ -6088,6 +6099,7 @@
|
|
|
6088
6099
|
"$ref": "#/components/schemas/apmAPMBigIpAWSReplaceType"
|
|
6089
6100
|
}
|
|
6090
6101
|
},
|
|
6102
|
+
"x-f5xc-description-short": "Virtual F5 BIG-IP service to be deployed on AWS Transit Gateway Site.",
|
|
6091
6103
|
"x-f5xc-minimum-configuration": {
|
|
6092
6104
|
"description": "Minimum configuration for apmAWSSiteTypeChoiceReplaceType",
|
|
6093
6105
|
"required_fields": [
|
|
@@ -6168,6 +6180,7 @@
|
|
|
6168
6180
|
"title": "Fail_if_referred.",
|
|
6169
6181
|
"format": "boolean",
|
|
6170
6182
|
"x-displayname": "Fail-If-Referred.",
|
|
6183
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
6171
6184
|
"x-f5xc-required-for": {
|
|
6172
6185
|
"minimum_config": false,
|
|
6173
6186
|
"create": false,
|
|
@@ -6192,7 +6205,7 @@
|
|
|
6192
6205
|
},
|
|
6193
6206
|
"x-original-maxLength": 1024,
|
|
6194
6207
|
"x-reconciled-from-discovery": true,
|
|
6195
|
-
"x-reconciled-at": "2026-01-
|
|
6208
|
+
"x-reconciled-at": "2026-01-07T15:52:38.602848+00:00"
|
|
6196
6209
|
},
|
|
6197
6210
|
"namespace": {
|
|
6198
6211
|
"type": "string",
|
|
@@ -6201,6 +6214,7 @@
|
|
|
6201
6214
|
"x-displayname": "Namespace",
|
|
6202
6215
|
"x-ves-example": "Ns1",
|
|
6203
6216
|
"x-f5xc-example": "ns1",
|
|
6217
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
6204
6218
|
"minLength": 0,
|
|
6205
6219
|
"maxLength": 6,
|
|
6206
6220
|
"x-f5xc-required-for": {
|
|
@@ -6211,7 +6225,7 @@
|
|
|
6211
6225
|
},
|
|
6212
6226
|
"x-original-maxLength": 1024,
|
|
6213
6227
|
"x-reconciled-from-discovery": true,
|
|
6214
|
-
"x-reconciled-at": "2026-01-
|
|
6228
|
+
"x-reconciled-at": "2026-01-07T15:52:38.602855+00:00"
|
|
6215
6229
|
}
|
|
6216
6230
|
},
|
|
6217
6231
|
"x-f5xc-minimum-configuration": {
|
|
@@ -6234,6 +6248,7 @@
|
|
|
6234
6248
|
"title": "BIG-IP APM on App Stack Bare Metal Site.",
|
|
6235
6249
|
"x-displayname": "BIG-IP APM on App Stack Bare Metal Site.",
|
|
6236
6250
|
"x-ves-proto-message": "ves.io.schema.bigip.apm.F5BigIpAppStackBareMetalChoiceReplaceType",
|
|
6251
|
+
"x-f5xc-description-short": "Virtual F5 BIG-IP APM service to be deployed on App Stack Bare Metal Site.",
|
|
6237
6252
|
"x-f5xc-minimum-configuration": {
|
|
6238
6253
|
"description": "Minimum configuration for apmF5BigIpAppStackBareMetalChoiceReplaceType",
|
|
6239
6254
|
"required_fields": [],
|
|
@@ -6255,6 +6270,7 @@
|
|
|
6255
6270
|
"$ref": "#/components/schemas/nfv_serviceF5BigIpAppStackBareMetalType"
|
|
6256
6271
|
}
|
|
6257
6272
|
},
|
|
6273
|
+
"x-f5xc-description-short": "Virtual BIG-IP specification for App Stack Bare Metal Site.",
|
|
6258
6274
|
"x-f5xc-minimum-configuration": {
|
|
6259
6275
|
"description": "Minimum configuration for apmF5BigIpAppStackBareMetalTypeChoice",
|
|
6260
6276
|
"required_fields": [
|
|
@@ -6285,6 +6301,7 @@
|
|
|
6285
6301
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
6286
6302
|
},
|
|
6287
6303
|
"x-displayname": "Deleted Referred Objects.",
|
|
6304
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6288
6305
|
"x-f5xc-required-for": {
|
|
6289
6306
|
"minimum_config": false,
|
|
6290
6307
|
"create": false,
|
|
@@ -6300,6 +6317,7 @@
|
|
|
6300
6317
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
6301
6318
|
},
|
|
6302
6319
|
"x-displayname": "Disabled Referred Objects.",
|
|
6320
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6303
6321
|
"x-f5xc-required-for": {
|
|
6304
6322
|
"minimum_config": false,
|
|
6305
6323
|
"create": false,
|
|
@@ -6318,6 +6336,7 @@
|
|
|
6318
6336
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
6319
6337
|
},
|
|
6320
6338
|
"x-displayname": "Referring Objects.",
|
|
6339
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
6321
6340
|
"x-f5xc-required-for": {
|
|
6322
6341
|
"minimum_config": false,
|
|
6323
6342
|
"create": false,
|
|
@@ -6339,6 +6358,8 @@
|
|
|
6339
6358
|
"$ref": "#/components/schemas/apmStatusObject"
|
|
6340
6359
|
},
|
|
6341
6360
|
"x-displayname": "Status",
|
|
6361
|
+
"x-f5xc-example": "active",
|
|
6362
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
6342
6363
|
"x-f5xc-required-for": {
|
|
6343
6364
|
"minimum_config": false,
|
|
6344
6365
|
"create": false,
|
|
@@ -6348,7 +6369,7 @@
|
|
|
6348
6369
|
"maxLength": 17,
|
|
6349
6370
|
"minLength": 17,
|
|
6350
6371
|
"x-reconciled-from-discovery": true,
|
|
6351
|
-
"x-reconciled-at": "2026-01-
|
|
6372
|
+
"x-reconciled-at": "2026-01-07T15:52:38.602873+00:00"
|
|
6352
6373
|
},
|
|
6353
6374
|
"system_metadata": {
|
|
6354
6375
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -6388,6 +6409,8 @@
|
|
|
6388
6409
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
6389
6410
|
],
|
|
6390
6411
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
6412
|
+
"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...",
|
|
6413
|
+
"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...",
|
|
6391
6414
|
"x-f5xc-minimum-configuration": {
|
|
6392
6415
|
"description": "Minimum configuration for apmGetResponseFormatCode",
|
|
6393
6416
|
"required_fields": [],
|
|
@@ -6413,6 +6436,7 @@
|
|
|
6413
6436
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
6414
6437
|
},
|
|
6415
6438
|
"x-displayname": "Errors",
|
|
6439
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
6416
6440
|
"x-f5xc-required-for": {
|
|
6417
6441
|
"minimum_config": false,
|
|
6418
6442
|
"create": false,
|
|
@@ -6428,6 +6452,8 @@
|
|
|
6428
6452
|
"$ref": "#/components/schemas/apmListResponseItem"
|
|
6429
6453
|
},
|
|
6430
6454
|
"x-displayname": "Items",
|
|
6455
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
6456
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
6431
6457
|
"x-f5xc-required-for": {
|
|
6432
6458
|
"minimum_config": false,
|
|
6433
6459
|
"create": false,
|
|
@@ -6461,6 +6487,8 @@
|
|
|
6461
6487
|
"description": "The set of annotations present on this apm.",
|
|
6462
6488
|
"title": "Annotations.",
|
|
6463
6489
|
"x-displayname": "Annotations.",
|
|
6490
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
6491
|
+
"x-f5xc-description-short": "The set of annotations present on this apm.",
|
|
6464
6492
|
"x-f5xc-required-for": {
|
|
6465
6493
|
"minimum_config": false,
|
|
6466
6494
|
"create": false,
|
|
@@ -6483,7 +6511,7 @@
|
|
|
6483
6511
|
},
|
|
6484
6512
|
"x-original-maxLength": 1024,
|
|
6485
6513
|
"x-reconciled-from-discovery": true,
|
|
6486
|
-
"x-reconciled-at": "2026-01-
|
|
6514
|
+
"x-reconciled-at": "2026-01-07T15:52:38.602886+00:00"
|
|
6487
6515
|
},
|
|
6488
6516
|
"disabled": {
|
|
6489
6517
|
"type": "boolean",
|
|
@@ -6491,6 +6519,8 @@
|
|
|
6491
6519
|
"title": "Disabled",
|
|
6492
6520
|
"format": "boolean",
|
|
6493
6521
|
"x-displayname": "Disabled",
|
|
6522
|
+
"x-f5xc-example": "True",
|
|
6523
|
+
"x-f5xc-description-short": "Value of true indicates apm is administratively disabled.",
|
|
6494
6524
|
"x-f5xc-required-for": {
|
|
6495
6525
|
"minimum_config": false,
|
|
6496
6526
|
"create": false,
|
|
@@ -6506,6 +6536,7 @@
|
|
|
6506
6536
|
"description": "The set of labels present on this apm.",
|
|
6507
6537
|
"title": "Labels",
|
|
6508
6538
|
"x-displayname": "Labels",
|
|
6539
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
6509
6540
|
"x-f5xc-required-for": {
|
|
6510
6541
|
"minimum_config": false,
|
|
6511
6542
|
"create": false,
|
|
@@ -6533,7 +6564,7 @@
|
|
|
6533
6564
|
},
|
|
6534
6565
|
"x-original-maxLength": 1024,
|
|
6535
6566
|
"x-reconciled-from-discovery": true,
|
|
6536
|
-
"x-reconciled-at": "2026-01-
|
|
6567
|
+
"x-reconciled-at": "2026-01-07T15:52:38.602897+00:00"
|
|
6537
6568
|
},
|
|
6538
6569
|
"namespace": {
|
|
6539
6570
|
"type": "string",
|
|
@@ -6552,7 +6583,7 @@
|
|
|
6552
6583
|
},
|
|
6553
6584
|
"x-original-maxLength": 1024,
|
|
6554
6585
|
"x-reconciled-from-discovery": true,
|
|
6555
|
-
"x-reconciled-at": "2026-01-
|
|
6586
|
+
"x-reconciled-at": "2026-01-07T15:52:38.602902+00:00"
|
|
6556
6587
|
},
|
|
6557
6588
|
"owner_view": {
|
|
6558
6589
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -6565,6 +6596,7 @@
|
|
|
6565
6596
|
"$ref": "#/components/schemas/apmStatusObject"
|
|
6566
6597
|
},
|
|
6567
6598
|
"x-displayname": "Status",
|
|
6599
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
6568
6600
|
"x-f5xc-required-for": {
|
|
6569
6601
|
"minimum_config": false,
|
|
6570
6602
|
"create": false,
|
|
@@ -6593,7 +6625,7 @@
|
|
|
6593
6625
|
"x-field-mutability": "read-only",
|
|
6594
6626
|
"x-original-maxLength": 1024,
|
|
6595
6627
|
"x-reconciled-from-discovery": true,
|
|
6596
|
-
"x-reconciled-at": "2026-01-
|
|
6628
|
+
"x-reconciled-at": "2026-01-07T15:52:38.602910+00:00"
|
|
6597
6629
|
},
|
|
6598
6630
|
"uid": {
|
|
6599
6631
|
"type": "string",
|
|
@@ -6614,9 +6646,11 @@
|
|
|
6614
6646
|
"x-original-maxLength": 1024,
|
|
6615
6647
|
"format": "uuid",
|
|
6616
6648
|
"x-reconciled-from-discovery": true,
|
|
6617
|
-
"x-reconciled-at": "2026-01-
|
|
6649
|
+
"x-reconciled-at": "2026-01-07T15:52:38.602916+00:00"
|
|
6618
6650
|
}
|
|
6619
6651
|
},
|
|
6652
|
+
"x-f5xc-description-short": "By default a summary of apm is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
6653
|
+
"x-f5xc-description-medium": "By default a summary of apm is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
6620
6654
|
"x-f5xc-minimum-configuration": {
|
|
6621
6655
|
"description": "Minimum configuration for apmListResponseItem",
|
|
6622
6656
|
"required_fields": [
|
|
@@ -6656,6 +6690,7 @@
|
|
|
6656
6690
|
"$ref": "#/components/schemas/bigipapmMetricTypeData"
|
|
6657
6691
|
},
|
|
6658
6692
|
"x-displayname": "Data",
|
|
6693
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
6659
6694
|
"x-f5xc-required-for": {
|
|
6660
6695
|
"minimum_config": false,
|
|
6661
6696
|
"create": false,
|
|
@@ -6670,6 +6705,7 @@
|
|
|
6670
6705
|
"$ref": "#/components/schemas/schemaUnitType"
|
|
6671
6706
|
}
|
|
6672
6707
|
},
|
|
6708
|
+
"x-f5xc-description-short": "Metric data contains the metric type and the corresponding metric value.",
|
|
6673
6709
|
"x-f5xc-minimum-configuration": {
|
|
6674
6710
|
"description": "Minimum configuration for apmMetricData",
|
|
6675
6711
|
"required_fields": [
|
|
@@ -6726,6 +6762,8 @@
|
|
|
6726
6762
|
"x-validation-rules": {
|
|
6727
6763
|
"ves.io.schema.rules.string.query_time": "true"
|
|
6728
6764
|
},
|
|
6765
|
+
"x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
|
|
6766
|
+
"x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
|
|
6729
6767
|
"minLength": 0,
|
|
6730
6768
|
"maxLength": 1024,
|
|
6731
6769
|
"x-f5xc-required-for": {
|
|
@@ -6758,6 +6796,8 @@
|
|
|
6758
6796
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
6759
6797
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
6760
6798
|
},
|
|
6799
|
+
"x-f5xc-description-short": "Select fields to be returned in the response.",
|
|
6800
|
+
"x-f5xc-description-medium": "Select fields to be returned in the response. One or more fields in {TX_THROUGHPUT_BYTES, CONNECTION_RATE, TX_THROUGHPUT_PACKETS, RX_THROUGHPUT_BYTES, RX_THROUGHPUT_PACKETS} can be specified. Required: YES.",
|
|
6761
6801
|
"x-f5xc-required-for": {
|
|
6762
6802
|
"minimum_config": false,
|
|
6763
6803
|
"create": false,
|
|
@@ -6772,6 +6812,8 @@
|
|
|
6772
6812
|
"x-displayname": "Filter",
|
|
6773
6813
|
"x-ves-example": "{HOSTNAME=\\\"WAF-1\\\"}",
|
|
6774
6814
|
"x-f5xc-example": "\"{HOSTNAME=\\\"WAF-1\\\"}\"",
|
|
6815
|
+
"x-f5xc-description-short": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or...",
|
|
6816
|
+
"x-f5xc-description-medium": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or more labels defined in MetricLabel {SITE, SERVICE, SERVICE_INSTANCE} can be specified in the filter. <value> := string <operator> :=...",
|
|
6775
6817
|
"minLength": 0,
|
|
6776
6818
|
"maxLength": 1024,
|
|
6777
6819
|
"x-f5xc-required-for": {
|
|
@@ -6789,6 +6831,7 @@
|
|
|
6789
6831
|
"$ref": "#/components/schemas/apmMetricLabel"
|
|
6790
6832
|
},
|
|
6791
6833
|
"x-displayname": "Group By",
|
|
6834
|
+
"x-f5xc-description-short": "Aggregate data by zero or more labels {SITE, SERVICE, SERVICE_INSTANCE}.",
|
|
6792
6835
|
"x-f5xc-required-for": {
|
|
6793
6836
|
"minimum_config": false,
|
|
6794
6837
|
"create": false,
|
|
@@ -6813,7 +6856,7 @@
|
|
|
6813
6856
|
},
|
|
6814
6857
|
"x-original-maxLength": 1024,
|
|
6815
6858
|
"x-reconciled-from-discovery": true,
|
|
6816
|
-
"x-reconciled-at": "2026-01-
|
|
6859
|
+
"x-reconciled-at": "2026-01-07T15:52:38.602932+00:00"
|
|
6817
6860
|
},
|
|
6818
6861
|
"start_time": {
|
|
6819
6862
|
"type": "string",
|
|
@@ -6828,6 +6871,8 @@
|
|
|
6828
6871
|
"x-validation-rules": {
|
|
6829
6872
|
"ves.io.schema.rules.string.query_time": "true"
|
|
6830
6873
|
},
|
|
6874
|
+
"x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
|
|
6875
|
+
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
|
|
6831
6876
|
"minLength": 0,
|
|
6832
6877
|
"maxLength": 1024,
|
|
6833
6878
|
"x-f5xc-required-for": {
|
|
@@ -6850,6 +6895,8 @@
|
|
|
6850
6895
|
"x-validation-rules": {
|
|
6851
6896
|
"ves.io.schema.rules.string.query_step": "true"
|
|
6852
6897
|
},
|
|
6898
|
+
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
|
|
6899
|
+
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
|
|
6853
6900
|
"minLength": 0,
|
|
6854
6901
|
"maxLength": 1024,
|
|
6855
6902
|
"x-f5xc-required-for": {
|
|
@@ -6860,6 +6907,7 @@
|
|
|
6860
6907
|
}
|
|
6861
6908
|
}
|
|
6862
6909
|
},
|
|
6910
|
+
"x-f5xc-description-short": "Request to GET the metrics for BIG-IP APM services.",
|
|
6863
6911
|
"x-f5xc-minimum-configuration": {
|
|
6864
6912
|
"description": "Minimum configuration for apmMetricsRequest",
|
|
6865
6913
|
"required_fields": [
|
|
@@ -6893,6 +6941,8 @@
|
|
|
6893
6941
|
"$ref": "#/components/schemas/apmMetricData"
|
|
6894
6942
|
},
|
|
6895
6943
|
"x-displayname": "Data",
|
|
6944
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
6945
|
+
"x-f5xc-description-short": "Data contains time-series metric data for BIG-IP APM services.",
|
|
6896
6946
|
"x-f5xc-required-for": {
|
|
6897
6947
|
"minimum_config": false,
|
|
6898
6948
|
"create": false,
|
|
@@ -6913,6 +6963,8 @@
|
|
|
6913
6963
|
"x-validation-rules": {
|
|
6914
6964
|
"ves.io.schema.rules.string.time_interval": "true"
|
|
6915
6965
|
},
|
|
6966
|
+
"x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.",
|
|
6967
|
+
"x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
|
|
6916
6968
|
"minLength": 0,
|
|
6917
6969
|
"maxLength": 1024,
|
|
6918
6970
|
"x-f5xc-required-for": {
|
|
@@ -6991,6 +7043,7 @@
|
|
|
6991
7043
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
6992
7044
|
},
|
|
6993
7045
|
"x-displayname": "Conditions.",
|
|
7046
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
6994
7047
|
"x-f5xc-required-for": {
|
|
6995
7048
|
"minimum_config": false,
|
|
6996
7049
|
"create": false,
|
|
@@ -7012,6 +7065,7 @@
|
|
|
7012
7065
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
7013
7066
|
},
|
|
7014
7067
|
"x-displayname": "Config Object.",
|
|
7068
|
+
"x-f5xc-description-short": "Reference to the object for current status.",
|
|
7015
7069
|
"x-f5xc-required-for": {
|
|
7016
7070
|
"minimum_config": false,
|
|
7017
7071
|
"create": false,
|
|
@@ -7020,6 +7074,7 @@
|
|
|
7020
7074
|
}
|
|
7021
7075
|
}
|
|
7022
7076
|
},
|
|
7077
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
7023
7078
|
"x-f5xc-minimum-configuration": {
|
|
7024
7079
|
"description": "Minimum configuration for apmStatusObject",
|
|
7025
7080
|
"required_fields": [
|
|
@@ -7054,6 +7109,7 @@
|
|
|
7054
7109
|
"$ref": "#/components/schemas/nfv_serviceServiceHttpsManagementType"
|
|
7055
7110
|
}
|
|
7056
7111
|
},
|
|
7112
|
+
"x-f5xc-description-short": "Creates a new APM as a service with configured parameters.",
|
|
7057
7113
|
"x-f5xc-minimum-configuration": {
|
|
7058
7114
|
"description": "Minimum configuration for bigipapmCreateSpecType",
|
|
7059
7115
|
"required_fields": [
|
|
@@ -7109,6 +7165,8 @@
|
|
|
7109
7165
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
7110
7166
|
}
|
|
7111
7167
|
},
|
|
7168
|
+
"x-f5xc-description-short": "Endpoint Service is a type of NFV service where the packets are destined to NFV and service modifies the destination with a new destination address.",
|
|
7169
|
+
"x-f5xc-description-medium": "Endpoint Service is a type of NFV service where the packets are destined to NFV and service modifies the destination with a new destination address.",
|
|
7112
7170
|
"x-f5xc-minimum-configuration": {
|
|
7113
7171
|
"description": "Minimum configuration for bigipapmEndpointServiceReplaceType",
|
|
7114
7172
|
"required_fields": [
|
|
@@ -7165,6 +7223,7 @@
|
|
|
7165
7223
|
"ves.io.schema.rules.string.ip": "true",
|
|
7166
7224
|
"ves.io.schema.rules.string.not_in": "0.0.0.0"
|
|
7167
7225
|
},
|
|
7226
|
+
"x-f5xc-description-short": "Exclusive with [automatic_vip] Enter IP address for the default VIP.",
|
|
7168
7227
|
"minLength": 0,
|
|
7169
7228
|
"maxLength": 1024,
|
|
7170
7229
|
"x-f5xc-required-for": {
|
|
@@ -7199,6 +7258,8 @@
|
|
|
7199
7258
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
7200
7259
|
}
|
|
7201
7260
|
},
|
|
7261
|
+
"x-f5xc-description-short": "Endpoint Service is a type of service where the packets are destined to BIG-IP APM device and service modifies the destination with a new...",
|
|
7262
|
+
"x-f5xc-description-medium": "Endpoint Service is a type of service where the packets are destined to BIG-IP APM device and service modifies the destination with a new destination address.",
|
|
7202
7263
|
"x-f5xc-minimum-configuration": {
|
|
7203
7264
|
"description": "Minimum configuration for bigipapmEndpointServiceType",
|
|
7204
7265
|
"required_fields": [
|
|
@@ -7274,6 +7335,8 @@
|
|
|
7274
7335
|
"default": "CPU_UTILIZATION",
|
|
7275
7336
|
"x-displayname": "Metric Type.",
|
|
7276
7337
|
"x-ves-proto-enum": "ves.io.schema.bigip.apm.MetricType",
|
|
7338
|
+
"x-f5xc-description-short": "List of metric types x-unit: \"percent\" x-unit: \"count\" x-unit: \"count\" x-unit: \"count\" x-unit: \"Bps\" x-unit: \"Bps\" x-unit: \"per second\" x-unit...",
|
|
7339
|
+
"x-f5xc-description-medium": "List of metric types x-unit: \"percent\" x-unit: \"count\" x-unit: \"count\" x-unit: \"count\" x-unit: \"Bps\" x-unit: \"Bps\" x-unit: \"per second\" x-unit: \"count\" x-unit: \"count\" x-unit: \"percentage\".",
|
|
7277
7340
|
"x-f5xc-minimum-configuration": {
|
|
7278
7341
|
"description": "Minimum configuration for bigipapmMetricType",
|
|
7279
7342
|
"required_fields": [],
|
|
@@ -7296,6 +7359,8 @@
|
|
|
7296
7359
|
"description": "Key contains the name/value pair.\n\"name\" is the label name defined in \"MetricLabel\"",
|
|
7297
7360
|
"title": "Key",
|
|
7298
7361
|
"x-displayname": "Key",
|
|
7362
|
+
"x-f5xc-example": "[REDACTED_PUBLIC_KEY]",
|
|
7363
|
+
"x-f5xc-description-short": "Key contains the name/value pair. \"name\" is the label name defined in \"MetricLabel\".",
|
|
7299
7364
|
"x-f5xc-required-for": {
|
|
7300
7365
|
"minimum_config": false,
|
|
7301
7366
|
"create": false,
|
|
@@ -7305,7 +7370,7 @@
|
|
|
7305
7370
|
"maxLength": 16,
|
|
7306
7371
|
"minLength": 7,
|
|
7307
7372
|
"x-reconciled-from-discovery": true,
|
|
7308
|
-
"x-reconciled-at": "2026-01-
|
|
7373
|
+
"x-reconciled-at": "2026-01-07T15:52:38.602984+00:00"
|
|
7309
7374
|
},
|
|
7310
7375
|
"value": {
|
|
7311
7376
|
"type": "array",
|
|
@@ -7324,9 +7389,11 @@
|
|
|
7324
7389
|
"maxLength": 15,
|
|
7325
7390
|
"minLength": 3,
|
|
7326
7391
|
"x-reconciled-from-discovery": true,
|
|
7327
|
-
"x-reconciled-at": "2026-01-
|
|
7392
|
+
"x-reconciled-at": "2026-01-07T15:52:38.602990+00:00"
|
|
7328
7393
|
}
|
|
7329
7394
|
},
|
|
7395
|
+
"x-f5xc-description-short": "Metric Type Data contains key/value pair that uniquely identifies the group_by labels specified in the request.",
|
|
7396
|
+
"x-f5xc-description-medium": "Metric Type Data contains key/value pair that uniquely identifies the group_by labels specified in the request.",
|
|
7330
7397
|
"x-f5xc-minimum-configuration": {
|
|
7331
7398
|
"description": "Minimum configuration for bigipapmMetricTypeData",
|
|
7332
7399
|
"required_fields": [
|
|
@@ -7359,6 +7426,7 @@
|
|
|
7359
7426
|
"$ref": "#/components/schemas/nfv_serviceServiceHttpsManagementType"
|
|
7360
7427
|
}
|
|
7361
7428
|
},
|
|
7429
|
+
"x-f5xc-description-short": "Replaces configured APM Service with new set of parameters.",
|
|
7362
7430
|
"x-f5xc-minimum-configuration": {
|
|
7363
7431
|
"description": "Minimum configuration for bigipapmReplaceSpecType",
|
|
7364
7432
|
"required_fields": [
|
|
@@ -7379,6 +7447,7 @@
|
|
|
7379
7447
|
"title": "Empty",
|
|
7380
7448
|
"x-displayname": "Empty",
|
|
7381
7449
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
7450
|
+
"x-f5xc-description-short": "Can be used for messages where no values are needed.",
|
|
7382
7451
|
"x-f5xc-minimum-configuration": {
|
|
7383
7452
|
"description": "Minimum configuration for ioschemaEmpty",
|
|
7384
7453
|
"required_fields": [],
|
|
@@ -7403,6 +7472,8 @@
|
|
|
7403
7472
|
"x-displayname": "Kind",
|
|
7404
7473
|
"x-ves-example": "Virtual_site.",
|
|
7405
7474
|
"x-f5xc-example": "virtual_site",
|
|
7475
|
+
"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\")",
|
|
7476
|
+
"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\").",
|
|
7406
7477
|
"minLength": 0,
|
|
7407
7478
|
"maxLength": 14,
|
|
7408
7479
|
"x-f5xc-required-for": {
|
|
@@ -7414,7 +7485,7 @@
|
|
|
7414
7485
|
"readOnly": true,
|
|
7415
7486
|
"x-original-maxLength": 1024,
|
|
7416
7487
|
"x-reconciled-from-discovery": true,
|
|
7417
|
-
"x-reconciled-at": "2026-01-
|
|
7488
|
+
"x-reconciled-at": "2026-01-07T15:52:38.602999+00:00"
|
|
7418
7489
|
},
|
|
7419
7490
|
"name": {
|
|
7420
7491
|
"type": "string",
|
|
@@ -7423,6 +7494,8 @@
|
|
|
7423
7494
|
"x-displayname": "Name",
|
|
7424
7495
|
"x-ves-example": "Contactus-route.",
|
|
7425
7496
|
"x-f5xc-example": "contactus-route",
|
|
7497
|
+
"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.",
|
|
7498
|
+
"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.",
|
|
7426
7499
|
"minLength": 0,
|
|
7427
7500
|
"maxLength": 16,
|
|
7428
7501
|
"x-f5xc-required-for": {
|
|
@@ -7433,7 +7506,7 @@
|
|
|
7433
7506
|
},
|
|
7434
7507
|
"x-original-maxLength": 1024,
|
|
7435
7508
|
"x-reconciled-from-discovery": true,
|
|
7436
|
-
"x-reconciled-at": "2026-01-
|
|
7509
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603004+00:00"
|
|
7437
7510
|
},
|
|
7438
7511
|
"namespace": {
|
|
7439
7512
|
"type": "string",
|
|
@@ -7442,6 +7515,8 @@
|
|
|
7442
7515
|
"x-displayname": "Namespace",
|
|
7443
7516
|
"x-ves-example": "Ns1",
|
|
7444
7517
|
"x-f5xc-example": "ns1",
|
|
7518
|
+
"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.",
|
|
7519
|
+
"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.",
|
|
7445
7520
|
"minLength": 0,
|
|
7446
7521
|
"maxLength": 6,
|
|
7447
7522
|
"x-f5xc-required-for": {
|
|
@@ -7452,7 +7527,7 @@
|
|
|
7452
7527
|
},
|
|
7453
7528
|
"x-original-maxLength": 1024,
|
|
7454
7529
|
"x-reconciled-from-discovery": true,
|
|
7455
|
-
"x-reconciled-at": "2026-01-
|
|
7530
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603008+00:00"
|
|
7456
7531
|
},
|
|
7457
7532
|
"tenant": {
|
|
7458
7533
|
"type": "string",
|
|
@@ -7461,6 +7536,8 @@
|
|
|
7461
7536
|
"x-displayname": "Tenant",
|
|
7462
7537
|
"x-ves-example": "Example-corp.",
|
|
7463
7538
|
"x-f5xc-example": "example-corp",
|
|
7539
|
+
"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.",
|
|
7540
|
+
"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.",
|
|
7464
7541
|
"minLength": 0,
|
|
7465
7542
|
"maxLength": 18,
|
|
7466
7543
|
"x-f5xc-required-for": {
|
|
@@ -7473,7 +7550,7 @@
|
|
|
7473
7550
|
"x-field-mutability": "read-only",
|
|
7474
7551
|
"x-original-maxLength": 1024,
|
|
7475
7552
|
"x-reconciled-from-discovery": true,
|
|
7476
|
-
"x-reconciled-at": "2026-01-
|
|
7553
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603012+00:00"
|
|
7477
7554
|
},
|
|
7478
7555
|
"uid": {
|
|
7479
7556
|
"type": "string",
|
|
@@ -7482,6 +7559,8 @@
|
|
|
7482
7559
|
"x-displayname": "UID",
|
|
7483
7560
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
7484
7561
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
7562
|
+
"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.",
|
|
7563
|
+
"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.",
|
|
7485
7564
|
"minLength": 0,
|
|
7486
7565
|
"maxLength": 36,
|
|
7487
7566
|
"x-f5xc-required-for": {
|
|
@@ -7495,9 +7574,11 @@
|
|
|
7495
7574
|
"x-original-maxLength": 1024,
|
|
7496
7575
|
"format": "uuid",
|
|
7497
7576
|
"x-reconciled-from-discovery": true,
|
|
7498
|
-
"x-reconciled-at": "2026-01-
|
|
7577
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603018+00:00"
|
|
7499
7578
|
}
|
|
7500
7579
|
},
|
|
7580
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
7581
|
+
"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...",
|
|
7501
7582
|
"x-f5xc-minimum-configuration": {
|
|
7502
7583
|
"description": "Minimum configuration for ioschemaObjectRefType",
|
|
7503
7584
|
"required_fields": [
|
|
@@ -7526,6 +7607,8 @@
|
|
|
7526
7607
|
"default": "BM_8_GB_MEMORY",
|
|
7527
7608
|
"x-displayname": "Bare Metal ServiceNode Memory Size.",
|
|
7528
7609
|
"x-ves-proto-enum": "ves.io.schema.nfv_service.BMNodeMemorySize",
|
|
7610
|
+
"x-f5xc-description-short": "Enum to define amount of memory to be assigned to the node - BM_8_GB_MEMORY: 8 GB - BM_16_GB_MEMORY: 16 GB - BM_32_GB_MEMORY: 32 GB.",
|
|
7611
|
+
"x-f5xc-description-medium": "Enum to define amount of memory to be assigned to the node - BM_8_GB_MEMORY: 8 GB - BM_16_GB_MEMORY: 16 GB - BM_32_GB_MEMORY: 32 GB.",
|
|
7529
7612
|
"x-f5xc-minimum-configuration": {
|
|
7530
7613
|
"description": "Minimum configuration for nfv_serviceBMNodeMemorySize",
|
|
7531
7614
|
"required_fields": [],
|
|
@@ -7547,6 +7630,8 @@
|
|
|
7547
7630
|
"default": "BM_4_VCPU",
|
|
7548
7631
|
"x-displayname": "Bare Metal ServiceNode Virtual CPU Count.",
|
|
7549
7632
|
"x-ves-proto-enum": "ves.io.schema.nfv_service.BMNodeVirtualCpuCount",
|
|
7633
|
+
"x-f5xc-description-short": "Enum to define number of virtual CPU's to be assigned to the node - BM_4_VCPU: 4 virtual CPUs - BM_8_VCPU: 8 virtual CPUs.",
|
|
7634
|
+
"x-f5xc-description-medium": "Enum to define number of virtual CPU's to be assigned to the node - BM_4_VCPU: 4 virtual CPUs - BM_8_VCPU: 8 virtual CPUs.",
|
|
7550
7635
|
"x-f5xc-minimum-configuration": {
|
|
7551
7636
|
"description": "Minimum configuration for nfv_serviceBMNodeVirtualCpuCount",
|
|
7552
7637
|
"required_fields": [],
|
|
@@ -7585,6 +7670,7 @@
|
|
|
7585
7670
|
"ves.io.schema.rules.string.max_len": "256",
|
|
7586
7671
|
"ves.io.schema.rules.string.min_len": "1"
|
|
7587
7672
|
},
|
|
7673
|
+
"x-f5xc-description-short": "Name of Utility Pool on BIG-IQ Required: YES.",
|
|
7588
7674
|
"x-f5xc-required-for": {
|
|
7589
7675
|
"minimum_config": false,
|
|
7590
7676
|
"create": false,
|
|
@@ -7610,6 +7696,8 @@
|
|
|
7610
7696
|
"ves.io.schema.rules.string.ip": "true",
|
|
7611
7697
|
"ves.io.schema.rules.string.not_in": "0.0.0.0"
|
|
7612
7698
|
},
|
|
7699
|
+
"x-f5xc-description-short": "IP Address from the TCP Load Balancer which is configured to communicate with License Server Required: YES.",
|
|
7700
|
+
"x-f5xc-description-medium": "IP Address from the TCP Load Balancer which is configured to communicate with License Server Required: YES.",
|
|
7613
7701
|
"minLength": 0,
|
|
7614
7702
|
"maxLength": 1024,
|
|
7615
7703
|
"x-f5xc-required-for": {
|
|
@@ -7642,6 +7730,7 @@
|
|
|
7642
7730
|
"ves.io.schema.rules.string.max_len": "256",
|
|
7643
7731
|
"ves.io.schema.rules.string.min_len": "1"
|
|
7644
7732
|
},
|
|
7733
|
+
"x-f5xc-description-short": "License offering name aka SKU name Required: YES.",
|
|
7645
7734
|
"x-f5xc-required-for": {
|
|
7646
7735
|
"minimum_config": false,
|
|
7647
7736
|
"create": false,
|
|
@@ -7669,6 +7758,7 @@
|
|
|
7669
7758
|
"ves.io.schema.rules.string.max_len": "256",
|
|
7670
7759
|
"ves.io.schema.rules.string.min_len": "1"
|
|
7671
7760
|
},
|
|
7761
|
+
"x-f5xc-description-short": "User Name used to access BIG-IQ to activate the license Required: YES.",
|
|
7672
7762
|
"x-f5xc-required-for": {
|
|
7673
7763
|
"minimum_config": false,
|
|
7674
7764
|
"create": false,
|
|
@@ -7677,6 +7767,7 @@
|
|
|
7677
7767
|
}
|
|
7678
7768
|
}
|
|
7679
7769
|
},
|
|
7770
|
+
"x-f5xc-description-short": "Specification for BIG-IQ Instance, where and what.",
|
|
7680
7771
|
"x-f5xc-minimum-configuration": {
|
|
7681
7772
|
"description": "Minimum configuration for nfv_serviceBigIqInstanceType",
|
|
7682
7773
|
"required_fields": [
|
|
@@ -7743,6 +7834,7 @@
|
|
|
7743
7834
|
"ves.io.schema.rules.message.required": "true",
|
|
7744
7835
|
"ves.io.schema.rules.string.max_len": "256"
|
|
7745
7836
|
},
|
|
7837
|
+
"x-f5xc-description-short": "Admin Username for BIG-IP Required: YES.",
|
|
7746
7838
|
"minLength": 0,
|
|
7747
7839
|
"x-f5xc-required-for": {
|
|
7748
7840
|
"minimum_config": false,
|
|
@@ -7778,6 +7870,7 @@
|
|
|
7778
7870
|
"ves.io.schema.rules.repeated.max_items": "1",
|
|
7779
7871
|
"ves.io.schema.rules.repeated.min_items": "1"
|
|
7780
7872
|
},
|
|
7873
|
+
"x-f5xc-description-short": "Specify how and where the service nodes are spawned Required: YES.",
|
|
7781
7874
|
"x-f5xc-required-for": {
|
|
7782
7875
|
"minimum_config": false,
|
|
7783
7876
|
"create": false,
|
|
@@ -7800,6 +7893,7 @@
|
|
|
7800
7893
|
"ves.io.schema.rules.message.required": "true",
|
|
7801
7894
|
"ves.io.schema.rules.string.uri": "true"
|
|
7802
7895
|
},
|
|
7896
|
+
"x-f5xc-description-short": "Public URL where BIG-IP VE image (qcow2) is hosted Required: YES.",
|
|
7803
7897
|
"minLength": 0,
|
|
7804
7898
|
"maxLength": 1024,
|
|
7805
7899
|
"x-f5xc-required-for": {
|
|
@@ -7829,6 +7923,7 @@
|
|
|
7829
7923
|
"ves.io.schema.rules.string.max_len": "8192",
|
|
7830
7924
|
"ves.io.schema.rules.string.min_len": "1"
|
|
7831
7925
|
},
|
|
7926
|
+
"x-f5xc-description-short": "Public SSH key for accessing the BIG-IP nodes. Required: YES.",
|
|
7832
7927
|
"x-f5xc-required-for": {
|
|
7833
7928
|
"minimum_config": false,
|
|
7834
7929
|
"create": false,
|
|
@@ -7837,6 +7932,7 @@
|
|
|
7837
7932
|
}
|
|
7838
7933
|
}
|
|
7839
7934
|
},
|
|
7935
|
+
"x-f5xc-description-short": "Virtual BIG-IP specification for App Stack bare metal.",
|
|
7840
7936
|
"x-f5xc-minimum-configuration": {
|
|
7841
7937
|
"description": "Minimum configuration for nfv_serviceF5BigIpAppStackBareMetalType",
|
|
7842
7938
|
"required_fields": [
|
|
@@ -7867,7 +7963,7 @@
|
|
|
7867
7963
|
},
|
|
7868
7964
|
"network_gateway": {
|
|
7869
7965
|
"type": "string",
|
|
7870
|
-
"description": "",
|
|
7966
|
+
"description": "Configuration parameter for network gateway",
|
|
7871
7967
|
"title": "BIG-IP Network Default Gateway.",
|
|
7872
7968
|
"x-displayname": "Default Gateway.",
|
|
7873
7969
|
"x-ves-example": "10.2.3.0",
|
|
@@ -7878,6 +7974,7 @@
|
|
|
7878
7974
|
"x-validation-rules": {
|
|
7879
7975
|
"ves.io.schema.rules.string.ipv4": "true"
|
|
7880
7976
|
},
|
|
7977
|
+
"x-f5xc-description-short": "Configuration parameter for network gateway.",
|
|
7881
7978
|
"minLength": 0,
|
|
7882
7979
|
"maxLength": 1024,
|
|
7883
7980
|
"x-f5xc-required-for": {
|
|
@@ -7975,6 +8072,8 @@
|
|
|
7975
8072
|
"ves.io.schema.rules.message.required": "true",
|
|
7976
8073
|
"ves.io.schema.rules.string.hostname": "true"
|
|
7977
8074
|
},
|
|
8075
|
+
"x-f5xc-description-short": "Domain suffix will be used along with node name to form URL to access node management Required: YES.",
|
|
8076
|
+
"x-f5xc-description-medium": "Domain suffix will be used along with node name to form URL to access node management Required: YES.",
|
|
7978
8077
|
"minLength": 0,
|
|
7979
8078
|
"maxLength": 1024,
|
|
7980
8079
|
"x-f5xc-required-for": {
|
|
@@ -7998,6 +8097,7 @@
|
|
|
7998
8097
|
"ves.io.schema.rules.uint32.gte": "1",
|
|
7999
8098
|
"ves.io.schema.rules.uint32.lte": "65535"
|
|
8000
8099
|
},
|
|
8100
|
+
"x-f5xc-description-short": "Exclusive with [default_https_port] Enter TCP port number.",
|
|
8001
8101
|
"minimum": 0,
|
|
8002
8102
|
"maximum": 2147483647,
|
|
8003
8103
|
"x-f5xc-required-for": {
|
|
@@ -8056,6 +8156,8 @@
|
|
|
8056
8156
|
"ves.io.schema.rules.message.required": "true",
|
|
8057
8157
|
"ves.io.schema.rules.string.pattern": "^([a-z]{2})-([a-z0-9]{4,20})-([a-z0-9]{2})$"
|
|
8058
8158
|
},
|
|
8159
|
+
"x-f5xc-description-short": "The AWS Availability Zone must be consistent with the AWS Region chosen. Please select an AZ in the same Region as your TGW Site Required: YES.",
|
|
8160
|
+
"x-f5xc-description-medium": "The AWS Availability Zone must be consistent with the AWS Region chosen. Please select an AZ in the same Region as your TGW Site Required: YES.",
|
|
8059
8161
|
"minLength": 0,
|
|
8060
8162
|
"maxLength": 1024,
|
|
8061
8163
|
"x-f5xc-required-for": {
|
|
@@ -8090,6 +8192,7 @@
|
|
|
8090
8192
|
"ves.io.schema.rules.string.max_len": "256",
|
|
8091
8193
|
"ves.io.schema.rules.string.min_len": "1"
|
|
8092
8194
|
},
|
|
8195
|
+
"x-f5xc-description-short": "Node Name will be used to assign as hostname to the service Required: YES.",
|
|
8093
8196
|
"x-f5xc-required-for": {
|
|
8094
8197
|
"minimum_config": false,
|
|
8095
8198
|
"create": false,
|
|
@@ -8113,6 +8216,7 @@
|
|
|
8113
8216
|
"x-validation-rules": {
|
|
8114
8217
|
"ves.io.schema.rules.string.ipv4_prefix": "true"
|
|
8115
8218
|
},
|
|
8219
|
+
"x-f5xc-description-short": "Exclusive with [automatic_prefix] Enter IP prefix for the tunnel, it has to be /30.",
|
|
8116
8220
|
"minLength": 0,
|
|
8117
8221
|
"maxLength": 1024,
|
|
8118
8222
|
"x-f5xc-required-for": {
|
|
@@ -8123,6 +8227,7 @@
|
|
|
8123
8227
|
}
|
|
8124
8228
|
}
|
|
8125
8229
|
},
|
|
8230
|
+
"x-f5xc-description-short": "Specification for service nodes, how and where.",
|
|
8126
8231
|
"x-f5xc-minimum-configuration": {
|
|
8127
8232
|
"description": "Minimum configuration for nfv_serviceServiceNodesAWSType",
|
|
8128
8233
|
"required_fields": [
|
|
@@ -8182,6 +8287,7 @@
|
|
|
8182
8287
|
"ves.io.schema.rules.string.max_len": "256",
|
|
8183
8288
|
"ves.io.schema.rules.string.min_len": "1"
|
|
8184
8289
|
},
|
|
8290
|
+
"x-f5xc-description-short": "Node Name will be used to assign as hostname to the service Required: YES.",
|
|
8185
8291
|
"x-f5xc-required-for": {
|
|
8186
8292
|
"minimum_config": false,
|
|
8187
8293
|
"create": false,
|
|
@@ -8190,6 +8296,7 @@
|
|
|
8190
8296
|
}
|
|
8191
8297
|
}
|
|
8192
8298
|
},
|
|
8299
|
+
"x-f5xc-description-short": "Specification for service nodes, how and where.",
|
|
8193
8300
|
"x-f5xc-minimum-configuration": {
|
|
8194
8301
|
"description": "Minimum configuration for nfv_serviceServiceNodesBareMetalType",
|
|
8195
8302
|
"required_fields": [
|
|
@@ -8213,6 +8320,8 @@
|
|
|
8213
8320
|
"type_url": {
|
|
8214
8321
|
"type": "string",
|
|
8215
8322
|
"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.",
|
|
8323
|
+
"x-f5xc-description-short": "URL identifying the protocol buffer message type.",
|
|
8324
|
+
"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 ).",
|
|
8216
8325
|
"minLength": 0,
|
|
8217
8326
|
"maxLength": 1024,
|
|
8218
8327
|
"x-f5xc-required-for": {
|
|
@@ -8236,9 +8345,11 @@
|
|
|
8236
8345
|
},
|
|
8237
8346
|
"x-original-maxLength": 1024,
|
|
8238
8347
|
"x-reconciled-from-discovery": true,
|
|
8239
|
-
"x-reconciled-at": "2026-01-
|
|
8348
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603075+00:00"
|
|
8240
8349
|
}
|
|
8241
8350
|
},
|
|
8351
|
+
"x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
|
|
8352
|
+
"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...",
|
|
8242
8353
|
"x-f5xc-minimum-configuration": {
|
|
8243
8354
|
"description": "Minimum configuration for protobufAny",
|
|
8244
8355
|
"required_fields": [
|
|
@@ -8267,6 +8378,8 @@
|
|
|
8267
8378
|
"x-displayname": "Decryption Provider.",
|
|
8268
8379
|
"x-ves-example": "Value",
|
|
8269
8380
|
"x-f5xc-example": "value",
|
|
8381
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
8382
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
8270
8383
|
"minLength": 0,
|
|
8271
8384
|
"maxLength": 1024,
|
|
8272
8385
|
"x-f5xc-required-for": {
|
|
@@ -8292,6 +8405,8 @@
|
|
|
8292
8405
|
"ves.io.schema.rules.message.required": "true",
|
|
8293
8406
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
8294
8407
|
},
|
|
8408
|
+
"x-f5xc-description-short": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
|
|
8409
|
+
"x-f5xc-description-medium": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
|
|
8295
8410
|
"minLength": 0,
|
|
8296
8411
|
"maxLength": 4,
|
|
8297
8412
|
"x-f5xc-required-for": {
|
|
@@ -8302,7 +8417,7 @@
|
|
|
8302
8417
|
},
|
|
8303
8418
|
"x-original-maxLength": 1024,
|
|
8304
8419
|
"x-reconciled-from-discovery": true,
|
|
8305
|
-
"x-reconciled-at": "2026-01-
|
|
8420
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603084+00:00"
|
|
8306
8421
|
},
|
|
8307
8422
|
"store_provider": {
|
|
8308
8423
|
"type": "string",
|
|
@@ -8311,6 +8426,8 @@
|
|
|
8311
8426
|
"x-displayname": "Store Provider.",
|
|
8312
8427
|
"x-ves-example": "Value",
|
|
8313
8428
|
"x-f5xc-example": "value",
|
|
8429
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
|
|
8430
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
|
|
8314
8431
|
"minLength": 0,
|
|
8315
8432
|
"maxLength": 1024,
|
|
8316
8433
|
"x-f5xc-required-for": {
|
|
@@ -8321,6 +8438,7 @@
|
|
|
8321
8438
|
}
|
|
8322
8439
|
}
|
|
8323
8440
|
},
|
|
8441
|
+
"x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
|
|
8324
8442
|
"x-f5xc-minimum-configuration": {
|
|
8325
8443
|
"description": "Minimum configuration for schemaBlindfoldSecretInfoType",
|
|
8326
8444
|
"required_fields": [
|
|
@@ -8350,6 +8468,8 @@
|
|
|
8350
8468
|
"x-displayname": "Provider",
|
|
8351
8469
|
"x-ves-example": "Box-provider.",
|
|
8352
8470
|
"x-f5xc-example": "box-provider",
|
|
8471
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
|
|
8472
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
|
|
8353
8473
|
"minLength": 0,
|
|
8354
8474
|
"maxLength": 8,
|
|
8355
8475
|
"x-f5xc-required-for": {
|
|
@@ -8360,7 +8480,7 @@
|
|
|
8360
8480
|
},
|
|
8361
8481
|
"x-original-maxLength": 1024,
|
|
8362
8482
|
"x-reconciled-from-discovery": true,
|
|
8363
|
-
"x-reconciled-at": "2026-01-
|
|
8483
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603093+00:00"
|
|
8364
8484
|
},
|
|
8365
8485
|
"url": {
|
|
8366
8486
|
"type": "string",
|
|
@@ -8381,6 +8501,8 @@
|
|
|
8381
8501
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
8382
8502
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
8383
8503
|
},
|
|
8504
|
+
"x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
|
|
8505
|
+
"x-f5xc-description-medium": "URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.",
|
|
8384
8506
|
"format": "uri",
|
|
8385
8507
|
"minLength": 0,
|
|
8386
8508
|
"x-f5xc-required-for": {
|
|
@@ -8391,6 +8513,7 @@
|
|
|
8391
8513
|
}
|
|
8392
8514
|
}
|
|
8393
8515
|
},
|
|
8516
|
+
"x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
|
|
8394
8517
|
"x-f5xc-minimum-configuration": {
|
|
8395
8518
|
"description": "Minimum configuration for schemaClearSecretInfoType",
|
|
8396
8519
|
"required_fields": [
|
|
@@ -8416,6 +8539,8 @@
|
|
|
8416
8539
|
"description": "Hostname of the instance of the site that sent the status.",
|
|
8417
8540
|
"title": "Hostname",
|
|
8418
8541
|
"x-displayname": "Hostname",
|
|
8542
|
+
"x-f5xc-example": "example-resource",
|
|
8543
|
+
"x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
|
|
8419
8544
|
"minLength": 0,
|
|
8420
8545
|
"maxLength": 1024,
|
|
8421
8546
|
"x-f5xc-required-for": {
|
|
@@ -8447,6 +8572,8 @@
|
|
|
8447
8572
|
"x-displayname": "Reason",
|
|
8448
8573
|
"x-ves-example": "Value",
|
|
8449
8574
|
"x-f5xc-example": "value",
|
|
8575
|
+
"x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
8576
|
+
"x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
8450
8577
|
"minLength": 0,
|
|
8451
8578
|
"maxLength": 43,
|
|
8452
8579
|
"x-f5xc-required-for": {
|
|
@@ -8457,13 +8584,15 @@
|
|
|
8457
8584
|
},
|
|
8458
8585
|
"x-original-maxLength": 1024,
|
|
8459
8586
|
"x-reconciled-from-discovery": true,
|
|
8460
|
-
"x-reconciled-at": "2026-01-
|
|
8587
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603103+00:00"
|
|
8461
8588
|
},
|
|
8462
8589
|
"service_name": {
|
|
8463
8590
|
"type": "string",
|
|
8464
8591
|
"description": "Name of the service that sent the status.",
|
|
8465
8592
|
"title": "Service name.",
|
|
8466
8593
|
"x-displayname": "Service Name.",
|
|
8594
|
+
"x-f5xc-example": "example-resource",
|
|
8595
|
+
"x-f5xc-description-short": "Name of the service that sent the status.",
|
|
8467
8596
|
"minLength": 0,
|
|
8468
8597
|
"maxLength": 1024,
|
|
8469
8598
|
"x-f5xc-required-for": {
|
|
@@ -8486,6 +8615,8 @@
|
|
|
8486
8615
|
"x-validation-rules": {
|
|
8487
8616
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
|
|
8488
8617
|
},
|
|
8618
|
+
"x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
|
|
8619
|
+
"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...",
|
|
8489
8620
|
"minLength": 0,
|
|
8490
8621
|
"maxLength": 17,
|
|
8491
8622
|
"x-f5xc-required-for": {
|
|
@@ -8496,7 +8627,7 @@
|
|
|
8496
8627
|
},
|
|
8497
8628
|
"x-original-maxLength": 1024,
|
|
8498
8629
|
"x-reconciled-from-discovery": true,
|
|
8499
|
-
"x-reconciled-at": "2026-01-
|
|
8630
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603109+00:00"
|
|
8500
8631
|
},
|
|
8501
8632
|
"type": {
|
|
8502
8633
|
"type": "string",
|
|
@@ -8511,6 +8642,8 @@
|
|
|
8511
8642
|
"x-validation-rules": {
|
|
8512
8643
|
"ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
|
|
8513
8644
|
},
|
|
8645
|
+
"x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
|
|
8646
|
+
"x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
|
|
8514
8647
|
"minLength": 0,
|
|
8515
8648
|
"maxLength": 1024,
|
|
8516
8649
|
"x-f5xc-required-for": {
|
|
@@ -8521,6 +8654,8 @@
|
|
|
8521
8654
|
}
|
|
8522
8655
|
}
|
|
8523
8656
|
},
|
|
8657
|
+
"x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
|
|
8658
|
+
"x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
|
|
8524
8659
|
"x-f5xc-minimum-configuration": {
|
|
8525
8660
|
"description": "Minimum configuration for schemaConditionType",
|
|
8526
8661
|
"required_fields": [
|
|
@@ -8556,6 +8691,8 @@
|
|
|
8556
8691
|
"default": "EOK",
|
|
8557
8692
|
"x-displayname": "Error Code.",
|
|
8558
8693
|
"x-ves-proto-enum": "ves.io.schema.ErrorCode",
|
|
8694
|
+
"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...",
|
|
8695
|
+
"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...",
|
|
8559
8696
|
"x-f5xc-minimum-configuration": {
|
|
8560
8697
|
"description": "Minimum configuration for schemaErrorCode",
|
|
8561
8698
|
"required_fields": [],
|
|
@@ -8596,6 +8733,7 @@
|
|
|
8596
8733
|
}
|
|
8597
8734
|
}
|
|
8598
8735
|
},
|
|
8736
|
+
"x-f5xc-description-short": "Information about a error in API operation.",
|
|
8599
8737
|
"x-f5xc-minimum-configuration": {
|
|
8600
8738
|
"description": "Minimum configuration for schemaErrorType",
|
|
8601
8739
|
"required_fields": [
|
|
@@ -8622,6 +8760,8 @@
|
|
|
8622
8760
|
"default": "INVALID_HASH_ALGORITHM",
|
|
8623
8761
|
"x-displayname": "Hash Algorithm.",
|
|
8624
8762
|
"x-ves-proto-enum": "ves.io.schema.HashAlgorithm",
|
|
8763
|
+
"x-f5xc-description-short": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.",
|
|
8764
|
+
"x-f5xc-description-medium": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.",
|
|
8625
8765
|
"x-f5xc-minimum-configuration": {
|
|
8626
8766
|
"description": "Minimum configuration for schemaHashAlgorithm",
|
|
8627
8767
|
"required_fields": [],
|
|
@@ -8662,6 +8802,7 @@
|
|
|
8662
8802
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
8663
8803
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
8664
8804
|
},
|
|
8805
|
+
"x-f5xc-description-short": "Ordered list of hash algorithms to be used. Required: YES.",
|
|
8665
8806
|
"x-f5xc-required-for": {
|
|
8666
8807
|
"minimum_config": false,
|
|
8667
8808
|
"create": false,
|
|
@@ -8670,6 +8811,7 @@
|
|
|
8670
8811
|
}
|
|
8671
8812
|
}
|
|
8672
8813
|
},
|
|
8814
|
+
"x-f5xc-description-short": "Specifies the hash algorithms to be used.",
|
|
8673
8815
|
"x-f5xc-minimum-configuration": {
|
|
8674
8816
|
"description": "Minimum configuration for schemaHashAlgorithms",
|
|
8675
8817
|
"required_fields": [
|
|
@@ -8695,6 +8837,7 @@
|
|
|
8695
8837
|
"title": "Name",
|
|
8696
8838
|
"x-displayname": "Name",
|
|
8697
8839
|
"x-f5xc-example": "example-resource",
|
|
8840
|
+
"x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
|
|
8698
8841
|
"minLength": 0,
|
|
8699
8842
|
"maxLength": 16,
|
|
8700
8843
|
"x-f5xc-required-for": {
|
|
@@ -8705,9 +8848,10 @@
|
|
|
8705
8848
|
},
|
|
8706
8849
|
"x-original-maxLength": 1024,
|
|
8707
8850
|
"x-reconciled-from-discovery": true,
|
|
8708
|
-
"x-reconciled-at": "2026-01-
|
|
8851
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603122+00:00"
|
|
8709
8852
|
}
|
|
8710
8853
|
},
|
|
8854
|
+
"x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
|
|
8711
8855
|
"x-f5xc-minimum-configuration": {
|
|
8712
8856
|
"description": "Minimum configuration for schemaInitializerType",
|
|
8713
8857
|
"required_fields": [
|
|
@@ -8735,6 +8879,8 @@
|
|
|
8735
8879
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
8736
8880
|
},
|
|
8737
8881
|
"x-displayname": "Pending",
|
|
8882
|
+
"x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
|
|
8883
|
+
"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.",
|
|
8738
8884
|
"x-f5xc-required-for": {
|
|
8739
8885
|
"minimum_config": false,
|
|
8740
8886
|
"create": false,
|
|
@@ -8746,6 +8892,7 @@
|
|
|
8746
8892
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
8747
8893
|
}
|
|
8748
8894
|
},
|
|
8895
|
+
"x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
|
|
8749
8896
|
"x-f5xc-minimum-configuration": {
|
|
8750
8897
|
"description": "Minimum configuration for schemaInitializersType",
|
|
8751
8898
|
"required_fields": [
|
|
@@ -8786,7 +8933,7 @@
|
|
|
8786
8933
|
},
|
|
8787
8934
|
"value": {
|
|
8788
8935
|
"type": "string",
|
|
8789
|
-
"description": "",
|
|
8936
|
+
"description": "Configuration parameter for value",
|
|
8790
8937
|
"title": "Value",
|
|
8791
8938
|
"x-displayname": "Value",
|
|
8792
8939
|
"x-ves-example": "15",
|
|
@@ -8801,9 +8948,10 @@
|
|
|
8801
8948
|
},
|
|
8802
8949
|
"x-original-maxLength": 1024,
|
|
8803
8950
|
"x-reconciled-from-discovery": true,
|
|
8804
|
-
"x-reconciled-at": "2026-01-
|
|
8951
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603133+00:00"
|
|
8805
8952
|
}
|
|
8806
8953
|
},
|
|
8954
|
+
"x-f5xc-description-short": "Metric data contains timestamp and the value.",
|
|
8807
8955
|
"x-f5xc-minimum-configuration": {
|
|
8808
8956
|
"description": "Minimum configuration for schemaMetricValue",
|
|
8809
8957
|
"required_fields": [
|
|
@@ -8843,6 +8991,8 @@
|
|
|
8843
8991
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
8844
8992
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
8845
8993
|
},
|
|
8994
|
+
"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.",
|
|
8995
|
+
"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.",
|
|
8846
8996
|
"x-f5xc-required-for": {
|
|
8847
8997
|
"minimum_config": false,
|
|
8848
8998
|
"create": false,
|
|
@@ -8864,6 +9014,7 @@
|
|
|
8864
9014
|
"x-validation-rules": {
|
|
8865
9015
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
8866
9016
|
},
|
|
9017
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
8867
9018
|
"minLength": 0,
|
|
8868
9019
|
"x-f5xc-required-for": {
|
|
8869
9020
|
"minimum_config": false,
|
|
@@ -8873,7 +9024,7 @@
|
|
|
8873
9024
|
},
|
|
8874
9025
|
"x-original-maxLength": 1200,
|
|
8875
9026
|
"x-reconciled-from-discovery": true,
|
|
8876
|
-
"x-reconciled-at": "2026-01-
|
|
9027
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603139+00:00"
|
|
8877
9028
|
},
|
|
8878
9029
|
"disable": {
|
|
8879
9030
|
"type": "boolean",
|
|
@@ -8882,6 +9033,7 @@
|
|
|
8882
9033
|
"format": "boolean",
|
|
8883
9034
|
"x-displayname": "Disable",
|
|
8884
9035
|
"x-f5xc-example": "true",
|
|
9036
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
8885
9037
|
"x-f5xc-required-for": {
|
|
8886
9038
|
"minimum_config": false,
|
|
8887
9039
|
"create": false,
|
|
@@ -8895,6 +9047,8 @@
|
|
|
8895
9047
|
"title": "Labels",
|
|
8896
9048
|
"x-displayname": "Labels",
|
|
8897
9049
|
"x-f5xc-example": "value",
|
|
9050
|
+
"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.",
|
|
9051
|
+
"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.",
|
|
8898
9052
|
"x-f5xc-required-for": {
|
|
8899
9053
|
"minimum_config": false,
|
|
8900
9054
|
"create": false,
|
|
@@ -8916,6 +9070,8 @@
|
|
|
8916
9070
|
"x-validation-rules": {
|
|
8917
9071
|
"ves.io.schema.rules.message.required": "true"
|
|
8918
9072
|
},
|
|
9073
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
9074
|
+
"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.",
|
|
8919
9075
|
"minLength": 0,
|
|
8920
9076
|
"maxLength": 16,
|
|
8921
9077
|
"x-f5xc-required-for": {
|
|
@@ -8926,7 +9082,7 @@
|
|
|
8926
9082
|
},
|
|
8927
9083
|
"x-original-maxLength": 1024,
|
|
8928
9084
|
"x-reconciled-from-discovery": true,
|
|
8929
|
-
"x-reconciled-at": "2026-01-
|
|
9085
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603147+00:00"
|
|
8930
9086
|
},
|
|
8931
9087
|
"namespace": {
|
|
8932
9088
|
"type": "string",
|
|
@@ -8935,6 +9091,8 @@
|
|
|
8935
9091
|
"x-displayname": "Namespace",
|
|
8936
9092
|
"x-ves-example": "Staging",
|
|
8937
9093
|
"x-f5xc-example": "staging",
|
|
9094
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
9095
|
+
"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 \"\".",
|
|
8938
9096
|
"minLength": 0,
|
|
8939
9097
|
"maxLength": 6,
|
|
8940
9098
|
"x-f5xc-required-for": {
|
|
@@ -8945,9 +9103,10 @@
|
|
|
8945
9103
|
},
|
|
8946
9104
|
"x-original-maxLength": 1024,
|
|
8947
9105
|
"x-reconciled-from-discovery": true,
|
|
8948
|
-
"x-reconciled-at": "2026-01-
|
|
9106
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603151+00:00"
|
|
8949
9107
|
}
|
|
8950
9108
|
},
|
|
9109
|
+
"x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
|
|
8951
9110
|
"x-f5xc-minimum-configuration": {
|
|
8952
9111
|
"description": "Minimum configuration for schemaObjectCreateMetaType",
|
|
8953
9112
|
"required_fields": [
|
|
@@ -8991,6 +9150,8 @@
|
|
|
8991
9150
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
8992
9151
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
8993
9152
|
},
|
|
9153
|
+
"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.",
|
|
9154
|
+
"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.",
|
|
8994
9155
|
"x-f5xc-required-for": {
|
|
8995
9156
|
"minimum_config": false,
|
|
8996
9157
|
"create": false,
|
|
@@ -9012,6 +9173,7 @@
|
|
|
9012
9173
|
"x-validation-rules": {
|
|
9013
9174
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
9014
9175
|
},
|
|
9176
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
9015
9177
|
"minLength": 0,
|
|
9016
9178
|
"x-f5xc-required-for": {
|
|
9017
9179
|
"minimum_config": false,
|
|
@@ -9021,7 +9183,7 @@
|
|
|
9021
9183
|
},
|
|
9022
9184
|
"x-original-maxLength": 1200,
|
|
9023
9185
|
"x-reconciled-from-discovery": true,
|
|
9024
|
-
"x-reconciled-at": "2026-01-
|
|
9186
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603157+00:00"
|
|
9025
9187
|
},
|
|
9026
9188
|
"disable": {
|
|
9027
9189
|
"type": "boolean",
|
|
@@ -9031,6 +9193,7 @@
|
|
|
9031
9193
|
"x-displayname": "Disable",
|
|
9032
9194
|
"x-ves-example": "True",
|
|
9033
9195
|
"x-f5xc-example": "true",
|
|
9196
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
9034
9197
|
"x-f5xc-required-for": {
|
|
9035
9198
|
"minimum_config": false,
|
|
9036
9199
|
"create": false,
|
|
@@ -9045,6 +9208,8 @@
|
|
|
9045
9208
|
"x-displayname": "Labels",
|
|
9046
9209
|
"x-ves-example": "Value",
|
|
9047
9210
|
"x-f5xc-example": "value",
|
|
9211
|
+
"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.",
|
|
9212
|
+
"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.",
|
|
9048
9213
|
"x-f5xc-required-for": {
|
|
9049
9214
|
"minimum_config": false,
|
|
9050
9215
|
"create": false,
|
|
@@ -9066,6 +9231,8 @@
|
|
|
9066
9231
|
"x-validation-rules": {
|
|
9067
9232
|
"ves.io.schema.rules.message.required": "true"
|
|
9068
9233
|
},
|
|
9234
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
9235
|
+
"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.",
|
|
9069
9236
|
"minLength": 0,
|
|
9070
9237
|
"maxLength": 16,
|
|
9071
9238
|
"x-f5xc-required-for": {
|
|
@@ -9076,7 +9243,7 @@
|
|
|
9076
9243
|
},
|
|
9077
9244
|
"x-original-maxLength": 1024,
|
|
9078
9245
|
"x-reconciled-from-discovery": true,
|
|
9079
|
-
"x-reconciled-at": "2026-01-
|
|
9246
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603165+00:00"
|
|
9080
9247
|
},
|
|
9081
9248
|
"namespace": {
|
|
9082
9249
|
"type": "string",
|
|
@@ -9085,6 +9252,8 @@
|
|
|
9085
9252
|
"x-displayname": "Namespace",
|
|
9086
9253
|
"x-ves-example": "Staging",
|
|
9087
9254
|
"x-f5xc-example": "staging",
|
|
9255
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
9256
|
+
"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 \"\".",
|
|
9088
9257
|
"minLength": 0,
|
|
9089
9258
|
"maxLength": 6,
|
|
9090
9259
|
"x-f5xc-required-for": {
|
|
@@ -9095,9 +9264,10 @@
|
|
|
9095
9264
|
},
|
|
9096
9265
|
"x-original-maxLength": 1024,
|
|
9097
9266
|
"x-reconciled-from-discovery": true,
|
|
9098
|
-
"x-reconciled-at": "2026-01-
|
|
9267
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603169+00:00"
|
|
9099
9268
|
}
|
|
9100
9269
|
},
|
|
9270
|
+
"x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
|
|
9101
9271
|
"x-f5xc-minimum-configuration": {
|
|
9102
9272
|
"description": "Minimum configuration for schemaObjectGetMetaType",
|
|
9103
9273
|
"required_fields": [
|
|
@@ -9141,6 +9311,8 @@
|
|
|
9141
9311
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
9142
9312
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
9143
9313
|
},
|
|
9314
|
+
"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.",
|
|
9315
|
+
"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.",
|
|
9144
9316
|
"x-f5xc-required-for": {
|
|
9145
9317
|
"minimum_config": false,
|
|
9146
9318
|
"create": false,
|
|
@@ -9162,6 +9334,7 @@
|
|
|
9162
9334
|
"x-validation-rules": {
|
|
9163
9335
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
9164
9336
|
},
|
|
9337
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
9165
9338
|
"minLength": 0,
|
|
9166
9339
|
"x-f5xc-required-for": {
|
|
9167
9340
|
"minimum_config": false,
|
|
@@ -9171,7 +9344,7 @@
|
|
|
9171
9344
|
},
|
|
9172
9345
|
"x-original-maxLength": 1200,
|
|
9173
9346
|
"x-reconciled-from-discovery": true,
|
|
9174
|
-
"x-reconciled-at": "2026-01-
|
|
9347
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603176+00:00"
|
|
9175
9348
|
},
|
|
9176
9349
|
"disable": {
|
|
9177
9350
|
"type": "boolean",
|
|
@@ -9180,6 +9353,7 @@
|
|
|
9180
9353
|
"format": "boolean",
|
|
9181
9354
|
"x-displayname": "Disable",
|
|
9182
9355
|
"x-f5xc-example": "true",
|
|
9356
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
9183
9357
|
"x-f5xc-required-for": {
|
|
9184
9358
|
"minimum_config": false,
|
|
9185
9359
|
"create": false,
|
|
@@ -9194,6 +9368,8 @@
|
|
|
9194
9368
|
"x-displayname": "Labels",
|
|
9195
9369
|
"x-ves-example": "Value",
|
|
9196
9370
|
"x-f5xc-example": "value",
|
|
9371
|
+
"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.",
|
|
9372
|
+
"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.",
|
|
9197
9373
|
"x-f5xc-required-for": {
|
|
9198
9374
|
"minimum_config": false,
|
|
9199
9375
|
"create": false,
|
|
@@ -9214,6 +9390,8 @@
|
|
|
9214
9390
|
"x-validation-rules": {
|
|
9215
9391
|
"ves.io.schema.rules.message.required": "true"
|
|
9216
9392
|
},
|
|
9393
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
9394
|
+
"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.",
|
|
9217
9395
|
"minLength": 0,
|
|
9218
9396
|
"maxLength": 16,
|
|
9219
9397
|
"x-f5xc-required-for": {
|
|
@@ -9224,7 +9402,7 @@
|
|
|
9224
9402
|
},
|
|
9225
9403
|
"x-original-maxLength": 1024,
|
|
9226
9404
|
"x-reconciled-from-discovery": true,
|
|
9227
|
-
"x-reconciled-at": "2026-01-
|
|
9405
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603183+00:00"
|
|
9228
9406
|
},
|
|
9229
9407
|
"namespace": {
|
|
9230
9408
|
"type": "string",
|
|
@@ -9233,6 +9411,8 @@
|
|
|
9233
9411
|
"x-displayname": "Namespace",
|
|
9234
9412
|
"x-ves-example": "Staging",
|
|
9235
9413
|
"x-f5xc-example": "staging",
|
|
9414
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
9415
|
+
"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 \"\".",
|
|
9236
9416
|
"minLength": 0,
|
|
9237
9417
|
"maxLength": 6,
|
|
9238
9418
|
"x-f5xc-required-for": {
|
|
@@ -9243,9 +9423,10 @@
|
|
|
9243
9423
|
},
|
|
9244
9424
|
"x-original-maxLength": 1024,
|
|
9245
9425
|
"x-reconciled-from-discovery": true,
|
|
9246
|
-
"x-reconciled-at": "2026-01-
|
|
9426
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603187+00:00"
|
|
9247
9427
|
}
|
|
9248
9428
|
},
|
|
9429
|
+
"x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
|
|
9249
9430
|
"x-f5xc-minimum-configuration": {
|
|
9250
9431
|
"description": "Minimum configuration for schemaObjectReplaceMetaType",
|
|
9251
9432
|
"required_fields": [
|
|
@@ -9292,6 +9473,8 @@
|
|
|
9292
9473
|
"ves.io.schema.rules.repeated.items.string.port_range": "true",
|
|
9293
9474
|
"ves.io.schema.rules.repeated.max_items": "128"
|
|
9294
9475
|
},
|
|
9476
|
+
"x-f5xc-description-short": "List of port ranges. Each range is a single port or a pair of start and end ports e.g. 8080-8192 Required: YES.",
|
|
9477
|
+
"x-f5xc-description-medium": "List of port ranges. Each range is a single port or a pair of start and end ports e.g. 8080-8192 Required: YES.",
|
|
9295
9478
|
"x-f5xc-required-for": {
|
|
9296
9479
|
"minimum_config": false,
|
|
9297
9480
|
"create": false,
|
|
@@ -9321,6 +9504,8 @@
|
|
|
9321
9504
|
"EncodingBase64"
|
|
9322
9505
|
],
|
|
9323
9506
|
"default": "EncodingNone",
|
|
9507
|
+
"x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
|
|
9508
|
+
"x-f5xc-description-medium": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. - EncodingNone: x-displayName: \"None\" No Encoding - EncodingBase64: Base64 x-displayName: \"Base64\" Base64 encoding.",
|
|
9324
9509
|
"x-f5xc-minimum-configuration": {
|
|
9325
9510
|
"description": "Minimum configuration for schemaSecretEncodingType",
|
|
9326
9511
|
"required_fields": [],
|
|
@@ -9346,6 +9531,7 @@
|
|
|
9346
9531
|
"$ref": "#/components/schemas/schemaClearSecretInfoType"
|
|
9347
9532
|
}
|
|
9348
9533
|
},
|
|
9534
|
+
"x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
|
|
9349
9535
|
"x-f5xc-minimum-configuration": {
|
|
9350
9536
|
"description": "Minimum configuration for schemaSecretType",
|
|
9351
9537
|
"required_fields": [
|
|
@@ -9372,6 +9558,8 @@
|
|
|
9372
9558
|
"title": "Creation_timestamp.",
|
|
9373
9559
|
"format": "date-time",
|
|
9374
9560
|
"x-displayname": "Creation Timestamp.",
|
|
9561
|
+
"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.",
|
|
9562
|
+
"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.",
|
|
9375
9563
|
"minLength": 0,
|
|
9376
9564
|
"maxLength": 1024,
|
|
9377
9565
|
"x-f5xc-required-for": {
|
|
@@ -9389,6 +9577,8 @@
|
|
|
9389
9577
|
"x-displayname": "Creator Class.",
|
|
9390
9578
|
"x-ves-example": "ver.re1.int.ves.I/O.",
|
|
9391
9579
|
"x-f5xc-example": "ver.re1.int.F5 XC",
|
|
9580
|
+
"x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
|
|
9581
|
+
"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.",
|
|
9392
9582
|
"minLength": 0,
|
|
9393
9583
|
"maxLength": 1024,
|
|
9394
9584
|
"x-f5xc-required-for": {
|
|
@@ -9406,6 +9596,8 @@
|
|
|
9406
9596
|
"x-displayname": "Creator ID.",
|
|
9407
9597
|
"x-ves-example": "Ver-instance-1.",
|
|
9408
9598
|
"x-f5xc-example": "ver-instance-1",
|
|
9599
|
+
"x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
|
|
9600
|
+
"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.",
|
|
9409
9601
|
"minLength": 0,
|
|
9410
9602
|
"maxLength": 1024,
|
|
9411
9603
|
"x-f5xc-required-for": {
|
|
@@ -9424,6 +9616,8 @@
|
|
|
9424
9616
|
"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)",
|
|
9425
9617
|
"title": "Status_id",
|
|
9426
9618
|
"x-displayname": "Status ID",
|
|
9619
|
+
"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...",
|
|
9620
|
+
"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).",
|
|
9427
9621
|
"minLength": 0,
|
|
9428
9622
|
"maxLength": 1024,
|
|
9429
9623
|
"x-f5xc-required-for": {
|
|
@@ -9441,6 +9635,7 @@
|
|
|
9441
9635
|
"x-displayname": "UID",
|
|
9442
9636
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
9443
9637
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
9638
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
|
|
9444
9639
|
"minLength": 0,
|
|
9445
9640
|
"maxLength": 36,
|
|
9446
9641
|
"x-f5xc-required-for": {
|
|
@@ -9453,13 +9648,14 @@
|
|
|
9453
9648
|
"x-original-maxLength": 1024,
|
|
9454
9649
|
"format": "uuid",
|
|
9455
9650
|
"x-reconciled-from-discovery": true,
|
|
9456
|
-
"x-reconciled-at": "2026-01-
|
|
9651
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603205+00:00"
|
|
9457
9652
|
},
|
|
9458
9653
|
"vtrp_id": {
|
|
9459
9654
|
"type": "string",
|
|
9460
9655
|
"description": "Origin of this status exchanged by VTRP.",
|
|
9461
9656
|
"title": "Vtrp_id",
|
|
9462
9657
|
"x-displayname": "VTRP ID",
|
|
9658
|
+
"x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
|
|
9463
9659
|
"minLength": 0,
|
|
9464
9660
|
"maxLength": 1024,
|
|
9465
9661
|
"x-f5xc-required-for": {
|
|
@@ -9476,6 +9672,7 @@
|
|
|
9476
9672
|
"title": "Vtrp_stale.",
|
|
9477
9673
|
"format": "boolean",
|
|
9478
9674
|
"x-displayname": "VTRP Stale.",
|
|
9675
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
9479
9676
|
"x-f5xc-required-for": {
|
|
9480
9677
|
"minimum_config": false,
|
|
9481
9678
|
"create": false,
|
|
@@ -9484,6 +9681,7 @@
|
|
|
9484
9681
|
}
|
|
9485
9682
|
}
|
|
9486
9683
|
},
|
|
9684
|
+
"x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
|
|
9487
9685
|
"x-f5xc-minimum-configuration": {
|
|
9488
9686
|
"description": "Minimum configuration for schemaStatusMetaType",
|
|
9489
9687
|
"required_fields": [
|
|
@@ -9514,6 +9712,8 @@
|
|
|
9514
9712
|
"default": "STATUS_DO_NOT_PUBLISH",
|
|
9515
9713
|
"x-displayname": "Status Publish Type.",
|
|
9516
9714
|
"x-ves-proto-enum": "ves.io.schema.StatusPublishType",
|
|
9715
|
+
"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.",
|
|
9716
|
+
"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.",
|
|
9517
9717
|
"x-f5xc-minimum-configuration": {
|
|
9518
9718
|
"description": "Minimum configuration for schemaStatusPublishType",
|
|
9519
9719
|
"required_fields": [],
|
|
@@ -9539,6 +9739,7 @@
|
|
|
9539
9739
|
"x-displayname": "Code",
|
|
9540
9740
|
"x-ves-example": "0",
|
|
9541
9741
|
"x-f5xc-example": "0",
|
|
9742
|
+
"x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
|
|
9542
9743
|
"minimum": 0,
|
|
9543
9744
|
"maximum": 2147483647,
|
|
9544
9745
|
"x-f5xc-required-for": {
|
|
@@ -9555,6 +9756,8 @@
|
|
|
9555
9756
|
"x-displayname": "Reason",
|
|
9556
9757
|
"x-ves-example": "Value",
|
|
9557
9758
|
"x-f5xc-example": "value",
|
|
9759
|
+
"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.",
|
|
9760
|
+
"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.",
|
|
9558
9761
|
"minLength": 0,
|
|
9559
9762
|
"maxLength": 43,
|
|
9560
9763
|
"x-f5xc-required-for": {
|
|
@@ -9565,7 +9768,7 @@
|
|
|
9565
9768
|
},
|
|
9566
9769
|
"x-original-maxLength": 1024,
|
|
9567
9770
|
"x-reconciled-from-discovery": true,
|
|
9568
|
-
"x-reconciled-at": "2026-01-
|
|
9771
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603215+00:00"
|
|
9569
9772
|
},
|
|
9570
9773
|
"status": {
|
|
9571
9774
|
"type": "string",
|
|
@@ -9574,6 +9777,7 @@
|
|
|
9574
9777
|
"x-displayname": "Status",
|
|
9575
9778
|
"x-ves-example": "Value",
|
|
9576
9779
|
"x-f5xc-example": "value",
|
|
9780
|
+
"x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
|
|
9577
9781
|
"minLength": 0,
|
|
9578
9782
|
"maxLength": 17,
|
|
9579
9783
|
"x-f5xc-required-for": {
|
|
@@ -9584,9 +9788,10 @@
|
|
|
9584
9788
|
},
|
|
9585
9789
|
"x-original-maxLength": 1024,
|
|
9586
9790
|
"x-reconciled-from-discovery": true,
|
|
9587
|
-
"x-reconciled-at": "2026-01-
|
|
9791
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603219+00:00"
|
|
9588
9792
|
}
|
|
9589
9793
|
},
|
|
9794
|
+
"x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
|
|
9590
9795
|
"x-f5xc-minimum-configuration": {
|
|
9591
9796
|
"description": "Minimum configuration for schemaStatusType",
|
|
9592
9797
|
"required_fields": [
|
|
@@ -9614,6 +9819,8 @@
|
|
|
9614
9819
|
"title": "Creation_timestamp.",
|
|
9615
9820
|
"format": "date-time",
|
|
9616
9821
|
"x-displayname": "Creation Timestamp.",
|
|
9822
|
+
"x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
|
|
9823
|
+
"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.",
|
|
9617
9824
|
"minLength": 0,
|
|
9618
9825
|
"maxLength": 1024,
|
|
9619
9826
|
"x-f5xc-required-for": {
|
|
@@ -9631,6 +9838,7 @@
|
|
|
9631
9838
|
"x-displayname": "Creator Class.",
|
|
9632
9839
|
"x-ves-example": "Prism",
|
|
9633
9840
|
"x-f5xc-example": "value",
|
|
9841
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
9634
9842
|
"minLength": 0,
|
|
9635
9843
|
"maxLength": 1024,
|
|
9636
9844
|
"x-f5xc-required-for": {
|
|
@@ -9648,6 +9856,7 @@
|
|
|
9648
9856
|
"x-displayname": "Creator ID.",
|
|
9649
9857
|
"x-ves-example": "Admin@example-corp.com.",
|
|
9650
9858
|
"x-f5xc-example": "value",
|
|
9859
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
9651
9860
|
"minLength": 0,
|
|
9652
9861
|
"maxLength": 1024,
|
|
9653
9862
|
"x-f5xc-required-for": {
|
|
@@ -9664,6 +9873,8 @@
|
|
|
9664
9873
|
"title": "Deletion_timestamp.",
|
|
9665
9874
|
"format": "date-time",
|
|
9666
9875
|
"x-displayname": "Deletion Timestamp.",
|
|
9876
|
+
"x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
|
|
9877
|
+
"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...",
|
|
9667
9878
|
"minLength": 0,
|
|
9668
9879
|
"maxLength": 1024,
|
|
9669
9880
|
"x-f5xc-required-for": {
|
|
@@ -9683,6 +9894,8 @@
|
|
|
9683
9894
|
"x-displayname": "Finalizers.",
|
|
9684
9895
|
"x-ves-example": "Value",
|
|
9685
9896
|
"x-f5xc-example": "value",
|
|
9897
|
+
"x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
|
|
9898
|
+
"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.",
|
|
9686
9899
|
"x-f5xc-required-for": {
|
|
9687
9900
|
"minimum_config": false,
|
|
9688
9901
|
"create": false,
|
|
@@ -9700,6 +9913,8 @@
|
|
|
9700
9913
|
"x-displayname": "Labels",
|
|
9701
9914
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
9702
9915
|
"x-f5xc-example": "'F5 XC/soft-deleted''true'",
|
|
9916
|
+
"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.",
|
|
9917
|
+
"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).",
|
|
9703
9918
|
"x-f5xc-required-for": {
|
|
9704
9919
|
"minimum_config": false,
|
|
9705
9920
|
"create": false,
|
|
@@ -9713,6 +9928,8 @@
|
|
|
9713
9928
|
"title": "Modification_timestamp.",
|
|
9714
9929
|
"format": "date-time",
|
|
9715
9930
|
"x-displayname": "Modification Timestamp.",
|
|
9931
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
9932
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
9716
9933
|
"minLength": 0,
|
|
9717
9934
|
"maxLength": 1024,
|
|
9718
9935
|
"x-f5xc-required-for": {
|
|
@@ -9731,6 +9948,8 @@
|
|
|
9731
9948
|
"x-displayname": "Object Index.",
|
|
9732
9949
|
"x-ves-example": "0",
|
|
9733
9950
|
"x-f5xc-example": "0",
|
|
9951
|
+
"x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
|
|
9952
|
+
"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.",
|
|
9734
9953
|
"minimum": 0,
|
|
9735
9954
|
"maximum": 2147483647,
|
|
9736
9955
|
"x-f5xc-required-for": {
|
|
@@ -9751,6 +9970,8 @@
|
|
|
9751
9970
|
"x-displayname": "Tenant",
|
|
9752
9971
|
"x-ves-example": "Example-corp.",
|
|
9753
9972
|
"x-f5xc-example": "example-corp",
|
|
9973
|
+
"x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
9974
|
+
"x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
9754
9975
|
"minLength": 0,
|
|
9755
9976
|
"maxLength": 18,
|
|
9756
9977
|
"x-f5xc-required-for": {
|
|
@@ -9762,7 +9983,7 @@
|
|
|
9762
9983
|
"x-field-mutability": "read-only",
|
|
9763
9984
|
"x-original-maxLength": 1024,
|
|
9764
9985
|
"x-reconciled-from-discovery": true,
|
|
9765
|
-
"x-reconciled-at": "2026-01-
|
|
9986
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603239+00:00"
|
|
9766
9987
|
},
|
|
9767
9988
|
"uid": {
|
|
9768
9989
|
"type": "string",
|
|
@@ -9771,6 +9992,8 @@
|
|
|
9771
9992
|
"x-displayname": "UID",
|
|
9772
9993
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
9773
9994
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
9995
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
|
|
9996
|
+
"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.",
|
|
9774
9997
|
"minLength": 0,
|
|
9775
9998
|
"maxLength": 36,
|
|
9776
9999
|
"x-f5xc-required-for": {
|
|
@@ -9783,9 +10006,11 @@
|
|
|
9783
10006
|
"x-original-maxLength": 1024,
|
|
9784
10007
|
"format": "uuid",
|
|
9785
10008
|
"x-reconciled-from-discovery": true,
|
|
9786
|
-
"x-reconciled-at": "2026-01-
|
|
10009
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603244+00:00"
|
|
9787
10010
|
}
|
|
9788
10011
|
},
|
|
10012
|
+
"x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
10013
|
+
"x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
9789
10014
|
"x-f5xc-minimum-configuration": {
|
|
9790
10015
|
"description": "Minimum configuration for schemaSystemObjectGetMetaType",
|
|
9791
10016
|
"required_fields": [
|
|
@@ -9839,6 +10064,8 @@
|
|
|
9839
10064
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
9840
10065
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
9841
10066
|
},
|
|
10067
|
+
"x-f5xc-description-short": "TLS certificate. Certificate or certificate chain in PEM format including the PEM headers.",
|
|
10068
|
+
"x-f5xc-description-medium": "TLS certificate. Certificate or certificate chain in PEM format including the PEM headers. Required: YES.",
|
|
9842
10069
|
"x-f5xc-required-for": {
|
|
9843
10070
|
"minimum_config": false,
|
|
9844
10071
|
"create": false,
|
|
@@ -9866,7 +10093,7 @@
|
|
|
9866
10093
|
},
|
|
9867
10094
|
"x-original-maxLength": 1024,
|
|
9868
10095
|
"x-reconciled-from-discovery": true,
|
|
9869
|
-
"x-reconciled-at": "2026-01-
|
|
10096
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603252+00:00"
|
|
9870
10097
|
},
|
|
9871
10098
|
"disable_ocsp_stapling": {
|
|
9872
10099
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
@@ -9909,6 +10136,8 @@
|
|
|
9909
10136
|
"default": "TLS_AUTO",
|
|
9910
10137
|
"x-displayname": "TLS Protocol.",
|
|
9911
10138
|
"x-ves-proto-enum": "ves.io.schema.TlsProtocol",
|
|
10139
|
+
"x-f5xc-description-short": "TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version.",
|
|
10140
|
+
"x-f5xc-description-medium": "TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version.",
|
|
9912
10141
|
"x-f5xc-minimum-configuration": {
|
|
9913
10142
|
"description": "Minimum configuration for schemaTlsProtocol",
|
|
9914
10143
|
"required_fields": [],
|
|
@@ -9931,6 +10160,7 @@
|
|
|
9931
10160
|
"default": "TREND_SENTIMENT_NONE",
|
|
9932
10161
|
"x-displayname": "Trend Sentiment.",
|
|
9933
10162
|
"x-ves-proto-enum": "ves.io.schema.TrendSentiment",
|
|
10163
|
+
"x-f5xc-description-short": "Trend sentiment Indicates trend sentiment is positive Indicates trend sentiment is negative.",
|
|
9934
10164
|
"x-f5xc-minimum-configuration": {
|
|
9935
10165
|
"description": "Minimum configuration for schemaTrendSentiment",
|
|
9936
10166
|
"required_fields": [],
|
|
@@ -9955,6 +10185,7 @@
|
|
|
9955
10185
|
"x-displayname": "Description.",
|
|
9956
10186
|
"x-ves-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval.",
|
|
9957
10187
|
"x-f5xc-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval",
|
|
10188
|
+
"x-f5xc-description-short": "Description of the method used to calculate trend.",
|
|
9958
10189
|
"minLength": 0,
|
|
9959
10190
|
"maxLength": 0,
|
|
9960
10191
|
"x-f5xc-required-for": {
|
|
@@ -9965,15 +10196,16 @@
|
|
|
9965
10196
|
},
|
|
9966
10197
|
"x-original-maxLength": 1024,
|
|
9967
10198
|
"x-reconciled-from-discovery": true,
|
|
9968
|
-
"x-reconciled-at": "2026-01-
|
|
10199
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603261+00:00"
|
|
9969
10200
|
},
|
|
9970
10201
|
"previous_value": {
|
|
9971
10202
|
"type": "string",
|
|
9972
|
-
"description": "",
|
|
10203
|
+
"description": "Configuration parameter for previous value",
|
|
9973
10204
|
"title": "Previous Value.",
|
|
9974
10205
|
"x-displayname": "Previous Value.",
|
|
9975
10206
|
"x-ves-example": "200.00",
|
|
9976
10207
|
"x-f5xc-example": "200.00",
|
|
10208
|
+
"x-f5xc-description-short": "Configuration parameter for previous value.",
|
|
9977
10209
|
"minLength": 0,
|
|
9978
10210
|
"maxLength": 1024,
|
|
9979
10211
|
"x-f5xc-required-for": {
|
|
@@ -9988,7 +10220,7 @@
|
|
|
9988
10220
|
},
|
|
9989
10221
|
"value": {
|
|
9990
10222
|
"type": "string",
|
|
9991
|
-
"description": "",
|
|
10223
|
+
"description": "Configuration parameter for value",
|
|
9992
10224
|
"title": "Value",
|
|
9993
10225
|
"x-displayname": "Value",
|
|
9994
10226
|
"x-ves-example": "-15",
|
|
@@ -10003,9 +10235,11 @@
|
|
|
10003
10235
|
},
|
|
10004
10236
|
"x-original-maxLength": 1024,
|
|
10005
10237
|
"x-reconciled-from-discovery": true,
|
|
10006
|
-
"x-reconciled-at": "2026-01-
|
|
10238
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603267+00:00"
|
|
10007
10239
|
}
|
|
10008
10240
|
},
|
|
10241
|
+
"x-f5xc-description-short": "Trend value contains trend value, trend sentiment and trend calculation description and window size.",
|
|
10242
|
+
"x-f5xc-description-medium": "Trend value contains trend value, trend sentiment and trend calculation description and window size.",
|
|
10009
10243
|
"x-f5xc-minimum-configuration": {
|
|
10010
10244
|
"description": "Minimum configuration for schemaTrendValue",
|
|
10011
10245
|
"required_fields": [
|
|
@@ -10057,6 +10291,7 @@
|
|
|
10057
10291
|
"default": "UNIT_MILLISECONDS",
|
|
10058
10292
|
"x-displayname": "Unit",
|
|
10059
10293
|
"x-ves-proto-enum": "ves.io.schema.UnitType",
|
|
10294
|
+
"x-f5xc-description-short": "UnitType is enumeration of units for scalar fields.",
|
|
10060
10295
|
"x-f5xc-minimum-configuration": {
|
|
10061
10296
|
"description": "Minimum configuration for schemaUnitType",
|
|
10062
10297
|
"required_fields": [],
|
|
@@ -10077,6 +10312,8 @@
|
|
|
10077
10312
|
"description": "X-displayName: \"Key\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.",
|
|
10078
10313
|
"title": "Key",
|
|
10079
10314
|
"x-f5xc-example": "key_pem",
|
|
10315
|
+
"x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
|
|
10316
|
+
"x-f5xc-description-medium": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key.",
|
|
10080
10317
|
"minLength": 0,
|
|
10081
10318
|
"maxLength": 16,
|
|
10082
10319
|
"x-f5xc-required-for": {
|
|
@@ -10087,13 +10324,14 @@
|
|
|
10087
10324
|
},
|
|
10088
10325
|
"x-original-maxLength": 1024,
|
|
10089
10326
|
"x-reconciled-from-discovery": true,
|
|
10090
|
-
"x-reconciled-at": "2026-01-
|
|
10327
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603273+00:00"
|
|
10091
10328
|
},
|
|
10092
10329
|
"location": {
|
|
10093
10330
|
"type": "string",
|
|
10094
10331
|
"description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
|
|
10095
10332
|
"title": "Location",
|
|
10096
10333
|
"x-f5xc-example": "v1/data/vhost_key",
|
|
10334
|
+
"x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
|
|
10097
10335
|
"minLength": 0,
|
|
10098
10336
|
"maxLength": 4,
|
|
10099
10337
|
"x-f5xc-required-for": {
|
|
@@ -10104,13 +10342,15 @@
|
|
|
10104
10342
|
},
|
|
10105
10343
|
"x-original-maxLength": 1024,
|
|
10106
10344
|
"x-reconciled-from-discovery": true,
|
|
10107
|
-
"x-reconciled-at": "2026-01-
|
|
10345
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603278+00:00"
|
|
10108
10346
|
},
|
|
10109
10347
|
"provider": {
|
|
10110
10348
|
"type": "string",
|
|
10111
10349
|
"description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
|
|
10112
10350
|
"title": "Provider",
|
|
10113
10351
|
"x-f5xc-example": "vault-vh-provider",
|
|
10352
|
+
"x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
10353
|
+
"x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
10114
10354
|
"minLength": 0,
|
|
10115
10355
|
"maxLength": 8,
|
|
10116
10356
|
"x-f5xc-required-for": {
|
|
@@ -10121,7 +10361,7 @@
|
|
|
10121
10361
|
},
|
|
10122
10362
|
"x-original-maxLength": 1024,
|
|
10123
10363
|
"x-reconciled-from-discovery": true,
|
|
10124
|
-
"x-reconciled-at": "2026-01-
|
|
10364
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603282+00:00"
|
|
10125
10365
|
},
|
|
10126
10366
|
"secret_encoding": {
|
|
10127
10367
|
"$ref": "#/components/schemas/schemaSecretEncodingType"
|
|
@@ -10132,6 +10372,8 @@
|
|
|
10132
10372
|
"title": "Version",
|
|
10133
10373
|
"format": "int64",
|
|
10134
10374
|
"x-f5xc-example": "1",
|
|
10375
|
+
"x-f5xc-description-short": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.",
|
|
10376
|
+
"x-f5xc-description-medium": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.",
|
|
10135
10377
|
"minimum": 0,
|
|
10136
10378
|
"maximum": 2147483647,
|
|
10137
10379
|
"x-f5xc-required-for": {
|
|
@@ -10143,9 +10385,11 @@
|
|
|
10143
10385
|
"maxLength": 1,
|
|
10144
10386
|
"minLength": 1,
|
|
10145
10387
|
"x-reconciled-from-discovery": true,
|
|
10146
|
-
"x-reconciled-at": "2026-01-
|
|
10388
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603288+00:00"
|
|
10147
10389
|
}
|
|
10148
10390
|
},
|
|
10391
|
+
"x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
10392
|
+
"x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
10149
10393
|
"x-f5xc-minimum-configuration": {
|
|
10150
10394
|
"description": "Minimum configuration for schemaVaultSecretInfoType",
|
|
10151
10395
|
"required_fields": [
|
|
@@ -10186,7 +10430,7 @@
|
|
|
10186
10430
|
},
|
|
10187
10431
|
"x-original-maxLength": 1024,
|
|
10188
10432
|
"x-reconciled-from-discovery": true,
|
|
10189
|
-
"x-reconciled-at": "2026-01-
|
|
10433
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603293+00:00"
|
|
10190
10434
|
},
|
|
10191
10435
|
"name": {
|
|
10192
10436
|
"type": "string",
|
|
@@ -10195,6 +10439,8 @@
|
|
|
10195
10439
|
"x-displayname": "Name",
|
|
10196
10440
|
"x-ves-example": "Contactus-route.",
|
|
10197
10441
|
"x-f5xc-example": "contactus-route",
|
|
10442
|
+
"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.",
|
|
10443
|
+
"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.",
|
|
10198
10444
|
"minLength": 0,
|
|
10199
10445
|
"maxLength": 16,
|
|
10200
10446
|
"x-f5xc-required-for": {
|
|
@@ -10205,7 +10451,7 @@
|
|
|
10205
10451
|
},
|
|
10206
10452
|
"x-original-maxLength": 1024,
|
|
10207
10453
|
"x-reconciled-from-discovery": true,
|
|
10208
|
-
"x-reconciled-at": "2026-01-
|
|
10454
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603298+00:00"
|
|
10209
10455
|
},
|
|
10210
10456
|
"namespace": {
|
|
10211
10457
|
"type": "string",
|
|
@@ -10214,6 +10460,8 @@
|
|
|
10214
10460
|
"x-displayname": "Namespace",
|
|
10215
10461
|
"x-ves-example": "Ns1",
|
|
10216
10462
|
"x-f5xc-example": "ns1",
|
|
10463
|
+
"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.",
|
|
10464
|
+
"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.",
|
|
10217
10465
|
"minLength": 0,
|
|
10218
10466
|
"maxLength": 6,
|
|
10219
10467
|
"x-f5xc-required-for": {
|
|
@@ -10224,7 +10472,7 @@
|
|
|
10224
10472
|
},
|
|
10225
10473
|
"x-original-maxLength": 1024,
|
|
10226
10474
|
"x-reconciled-from-discovery": true,
|
|
10227
|
-
"x-reconciled-at": "2026-01-
|
|
10475
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603302+00:00"
|
|
10228
10476
|
},
|
|
10229
10477
|
"uid": {
|
|
10230
10478
|
"type": "string",
|
|
@@ -10245,9 +10493,10 @@
|
|
|
10245
10493
|
"x-original-maxLength": 1024,
|
|
10246
10494
|
"format": "uuid",
|
|
10247
10495
|
"x-reconciled-from-discovery": true,
|
|
10248
|
-
"x-reconciled-at": "2026-01-
|
|
10496
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603307+00:00"
|
|
10249
10497
|
}
|
|
10250
10498
|
},
|
|
10499
|
+
"x-f5xc-description-short": "ViewRefType represents a reference to a view.",
|
|
10251
10500
|
"x-f5xc-minimum-configuration": {
|
|
10252
10501
|
"description": "Minimum configuration for schemaViewRefType",
|
|
10253
10502
|
"required_fields": [
|
|
@@ -10273,6 +10522,7 @@
|
|
|
10273
10522
|
"description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
|
|
10274
10523
|
"title": "Name",
|
|
10275
10524
|
"x-f5xc-example": "ChargeBack-API-Key",
|
|
10525
|
+
"x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
|
|
10276
10526
|
"minLength": 0,
|
|
10277
10527
|
"maxLength": 16,
|
|
10278
10528
|
"x-f5xc-required-for": {
|
|
@@ -10283,9 +10533,10 @@
|
|
|
10283
10533
|
},
|
|
10284
10534
|
"x-original-maxLength": 1024,
|
|
10285
10535
|
"x-reconciled-from-discovery": true,
|
|
10286
|
-
"x-reconciled-at": "2026-01-
|
|
10536
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603312+00:00"
|
|
10287
10537
|
}
|
|
10288
10538
|
},
|
|
10539
|
+
"x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
|
|
10289
10540
|
"x-f5xc-minimum-configuration": {
|
|
10290
10541
|
"description": "Minimum configuration for schemaWingmanSecretInfoType",
|
|
10291
10542
|
"required_fields": [
|
|
@@ -10313,6 +10564,8 @@
|
|
|
10313
10564
|
"default": "XFCC_NONE",
|
|
10314
10565
|
"x-displayname": "XFCC Elements.",
|
|
10315
10566
|
"x-ves-proto-enum": "ves.io.schema.XfccElement",
|
|
10567
|
+
"x-f5xc-description-short": "X-Forwarded-Client-Cert custom cookie elements The entire client certificate in URL encoded PEM format.",
|
|
10568
|
+
"x-f5xc-description-medium": "X-Forwarded-Client-Cert custom cookie elements The entire client certificate in URL encoded PEM format. The entire client certificate chain (including the leaf certificate) in URL encoded PEM format. The Subject field of the current client certificate.",
|
|
10316
10569
|
"x-f5xc-minimum-configuration": {
|
|
10317
10570
|
"description": "Minimum configuration for schemaXfccElement",
|
|
10318
10571
|
"required_fields": [],
|
|
@@ -10350,6 +10603,8 @@
|
|
|
10350
10603
|
"ves.io.schema.rules.string.max_bytes": "128",
|
|
10351
10604
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
10352
10605
|
},
|
|
10606
|
+
"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.",
|
|
10607
|
+
"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. Required: YES.",
|
|
10353
10608
|
"x-f5xc-required-for": {
|
|
10354
10609
|
"minimum_config": false,
|
|
10355
10610
|
"create": false,
|
|
@@ -10358,7 +10613,7 @@
|
|
|
10358
10613
|
},
|
|
10359
10614
|
"x-original-maxLength": 128,
|
|
10360
10615
|
"x-reconciled-from-discovery": true,
|
|
10361
|
-
"x-reconciled-at": "2026-01-
|
|
10616
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603317+00:00"
|
|
10362
10617
|
},
|
|
10363
10618
|
"namespace": {
|
|
10364
10619
|
"type": "string",
|
|
@@ -10374,6 +10629,8 @@
|
|
|
10374
10629
|
"x-validation-rules": {
|
|
10375
10630
|
"ves.io.schema.rules.string.max_bytes": "64"
|
|
10376
10631
|
},
|
|
10632
|
+
"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.",
|
|
10633
|
+
"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.",
|
|
10377
10634
|
"minLength": 0,
|
|
10378
10635
|
"x-f5xc-required-for": {
|
|
10379
10636
|
"minimum_config": false,
|
|
@@ -10383,7 +10640,7 @@
|
|
|
10383
10640
|
},
|
|
10384
10641
|
"x-original-maxLength": 64,
|
|
10385
10642
|
"x-reconciled-from-discovery": true,
|
|
10386
|
-
"x-reconciled-at": "2026-01-
|
|
10643
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603321+00:00"
|
|
10387
10644
|
},
|
|
10388
10645
|
"tenant": {
|
|
10389
10646
|
"type": "string",
|
|
@@ -10399,6 +10656,8 @@
|
|
|
10399
10656
|
"x-validation-rules": {
|
|
10400
10657
|
"ves.io.schema.rules.string.max_bytes": "64"
|
|
10401
10658
|
},
|
|
10659
|
+
"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.",
|
|
10660
|
+
"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.",
|
|
10402
10661
|
"minLength": 0,
|
|
10403
10662
|
"x-f5xc-required-for": {
|
|
10404
10663
|
"minimum_config": false,
|
|
@@ -10410,9 +10669,11 @@
|
|
|
10410
10669
|
"x-field-mutability": "read-only",
|
|
10411
10670
|
"x-original-maxLength": 64,
|
|
10412
10671
|
"x-reconciled-from-discovery": true,
|
|
10413
|
-
"x-reconciled-at": "2026-01-
|
|
10672
|
+
"x-reconciled-at": "2026-01-07T15:52:38.603326+00:00"
|
|
10414
10673
|
}
|
|
10415
10674
|
},
|
|
10675
|
+
"x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).",
|
|
10676
|
+
"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.",
|
|
10416
10677
|
"x-f5xc-minimum-configuration": {
|
|
10417
10678
|
"description": "Minimum configuration for schemaviewsObjectRefType",
|
|
10418
10679
|
"required_fields": [
|
|
@@ -10502,6 +10763,8 @@
|
|
|
10502
10763
|
"title": "Modification_timestamp.",
|
|
10503
10764
|
"format": "date-time",
|
|
10504
10765
|
"x-displayname": "Modification Timestamp.",
|
|
10766
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this status was last modified.",
|
|
10767
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this status was last modified.",
|
|
10505
10768
|
"minLength": 0,
|
|
10506
10769
|
"maxLength": 1024,
|
|
10507
10770
|
"x-f5xc-required-for": {
|
|
@@ -10535,6 +10798,7 @@
|
|
|
10535
10798
|
"x-displayname": "Terraform Output.",
|
|
10536
10799
|
"x-ves-example": "Value",
|
|
10537
10800
|
"x-f5xc-example": "value",
|
|
10801
|
+
"x-f5xc-description-short": "The value of an \"output\" variable from the terraform state file.",
|
|
10538
10802
|
"minLength": 0,
|
|
10539
10803
|
"maxLength": 1024,
|
|
10540
10804
|
"x-f5xc-required-for": {
|
|
@@ -10652,6 +10916,8 @@
|
|
|
10652
10916
|
"UPGRADE_NOT_REQUIRED"
|
|
10653
10917
|
],
|
|
10654
10918
|
"default": "UPGRADE_SUCCESSFUL",
|
|
10919
|
+
"x-f5xc-description-short": "X-displayName: \"Upgrade State\" Terraform State after version Upgrade - UPGRADE_SUCCESSFUL: x-displayName: \"Upgrade successful\" - UPGRADE_ERRORED...",
|
|
10920
|
+
"x-f5xc-description-medium": "X-displayName: \"Upgrade State\" Terraform State after version Upgrade - UPGRADE_SUCCESSFUL: x-displayName: \"Upgrade successful\" - UPGRADE_ERRORED: x-displayName: \"Upgrade errored\" - UPGRADE_NOT_REQUIRED: x-displayName: \"Upgrade not required\".",
|
|
10655
10921
|
"x-f5xc-minimum-configuration": {
|
|
10656
10922
|
"description": "Minimum configuration for terraform_parametersUpgradeState",
|
|
10657
10923
|
"required_fields": [],
|
|
@@ -10673,6 +10939,8 @@
|
|
|
10673
10939
|
"$ref": "#/components/schemas/schemaviewsObjectRefType"
|
|
10674
10940
|
}
|
|
10675
10941
|
},
|
|
10942
|
+
"x-f5xc-description-short": "Defines a way to advertise a load balancer on public.",
|
|
10943
|
+
"x-f5xc-description-medium": "Defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available.",
|
|
10676
10944
|
"x-f5xc-minimum-configuration": {
|
|
10677
10945
|
"description": "Minimum configuration for viewsAdvertisePublic",
|
|
10678
10946
|
"required_fields": [
|
|
@@ -10711,6 +10979,7 @@
|
|
|
10711
10979
|
"ves.io.schema.rules.string.ipv4_prefix": "true",
|
|
10712
10980
|
"ves.io.schema.rules.string.max_ip_prefix_length": "28"
|
|
10713
10981
|
},
|
|
10982
|
+
"x-f5xc-description-short": "IPv4 subnet prefix for this subnet Required: YES.",
|
|
10714
10983
|
"format": "ipv4",
|
|
10715
10984
|
"minLength": 0,
|
|
10716
10985
|
"maxLength": 1024,
|
|
@@ -10722,6 +10991,7 @@
|
|
|
10722
10991
|
}
|
|
10723
10992
|
}
|
|
10724
10993
|
},
|
|
10994
|
+
"x-f5xc-description-short": "Parameters for creating a new cloud subnet.",
|
|
10725
10995
|
"x-f5xc-minimum-configuration": {
|
|
10726
10996
|
"description": "Minimum configuration for viewsCloudSubnetParamType",
|
|
10727
10997
|
"required_fields": [
|
|
@@ -10758,6 +11028,7 @@
|
|
|
10758
11028
|
"ves.io.schema.rules.string.max_len": "64",
|
|
10759
11029
|
"ves.io.schema.rules.string.pattern": "^(subnet-)([a-z0-9]{8}|[a-z0-9]{17})$"
|
|
10760
11030
|
},
|
|
11031
|
+
"x-f5xc-description-short": "Exclusive with [subnet_param] Information about existing subnet ID.",
|
|
10761
11032
|
"minLength": 0,
|
|
10762
11033
|
"x-f5xc-required-for": {
|
|
10763
11034
|
"minimum_config": false,
|
|
@@ -10813,6 +11084,7 @@
|
|
|
10813
11084
|
"ves.io.schema.rules.repeated.items.string.in": "[\\\"TLS_AES_128_GCM_SHA256\\\",\\\"TLS_AES_256_GCM_SHA384\\\",\\\"TLS_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_256_GCM_SHA384\\\"]",
|
|
10814
11085
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
10815
11086
|
},
|
|
11087
|
+
"x-f5xc-description-short": "The TLS listener will only support the specified cipher list. Required: YES.",
|
|
10816
11088
|
"x-f5xc-required-for": {
|
|
10817
11089
|
"minimum_config": false,
|
|
10818
11090
|
"create": false,
|
|
@@ -10827,6 +11099,7 @@
|
|
|
10827
11099
|
"$ref": "#/components/schemas/schemaTlsProtocol"
|
|
10828
11100
|
}
|
|
10829
11101
|
},
|
|
11102
|
+
"x-f5xc-description-short": "Defines TLS protocol config including min/max versions and allowed ciphers.",
|
|
10830
11103
|
"x-f5xc-minimum-configuration": {
|
|
10831
11104
|
"description": "Minimum configuration for viewsCustomCiphers",
|
|
10832
11105
|
"required_fields": [
|
|
@@ -10873,6 +11146,8 @@
|
|
|
10873
11146
|
"ves.io.schema.rules.repeated.max_items": "16",
|
|
10874
11147
|
"ves.io.schema.rules.repeated.min_items": "1"
|
|
10875
11148
|
},
|
|
11149
|
+
"x-f5xc-description-short": "Users can add one or more certificates that share the same set of domains.",
|
|
11150
|
+
"x-f5xc-description-medium": "Users can add one or more certificates that share the same set of domains. For example, domain.com and *.domain.com - but use different signature algorithms Required: YES.",
|
|
10876
11151
|
"x-f5xc-required-for": {
|
|
10877
11152
|
"minimum_config": false,
|
|
10878
11153
|
"create": false,
|
|
@@ -10918,6 +11193,9 @@
|
|
|
10918
11193
|
"title": "Client_certificate_optional.",
|
|
10919
11194
|
"format": "boolean",
|
|
10920
11195
|
"x-displayname": "Client Certificate Optional.",
|
|
11196
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
11197
|
+
"x-f5xc-description-short": "Client certificate is optional. If the client has provided a certificate, the load balancer will verify it.",
|
|
11198
|
+
"x-f5xc-description-medium": "Client certificate is optional. If the client has provided a certificate, the load balancer will verify it. If certification verification fails, the connection will be terminated.",
|
|
10921
11199
|
"x-f5xc-required-for": {
|
|
10922
11200
|
"minimum_config": false,
|
|
10923
11201
|
"create": false,
|
|
@@ -10951,6 +11229,7 @@
|
|
|
10951
11229
|
"ves.io.schema.rules.string.min_bytes": "1",
|
|
10952
11230
|
"ves.io.schema.rules.string.truststore_url": "true"
|
|
10953
11231
|
},
|
|
11232
|
+
"x-f5xc-description-short": "Exclusive with [trusted_ca] Upload a Root CA Certificate specifically for this Load Balancer.",
|
|
10954
11233
|
"x-f5xc-required-for": {
|
|
10955
11234
|
"minimum_config": false,
|
|
10956
11235
|
"create": false,
|
|
@@ -10965,6 +11244,7 @@
|
|
|
10965
11244
|
"$ref": "#/components/schemas/viewsXfccHeaderKeys"
|
|
10966
11245
|
}
|
|
10967
11246
|
},
|
|
11247
|
+
"x-f5xc-description-short": "Validation context for downstream client TLS connections.",
|
|
10968
11248
|
"x-f5xc-minimum-configuration": {
|
|
10969
11249
|
"description": "Minimum configuration for viewsDownstreamTlsValidationContext",
|
|
10970
11250
|
"required_fields": [
|
|
@@ -11005,6 +11285,7 @@
|
|
|
11005
11285
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
11006
11286
|
}
|
|
11007
11287
|
},
|
|
11288
|
+
"x-f5xc-description-short": "Defines various OPTIONS to configure TLS configuration parameters.",
|
|
11008
11289
|
"x-f5xc-minimum-configuration": {
|
|
11009
11290
|
"description": "Minimum configuration for viewsTlsConfig",
|
|
11010
11291
|
"required_fields": [
|
|
@@ -11046,6 +11327,7 @@
|
|
|
11046
11327
|
"ves.io.schema.rules.repeated.items.enum.defined_only": "true",
|
|
11047
11328
|
"ves.io.schema.rules.repeated.items.enum.not_in": "[0]"
|
|
11048
11329
|
},
|
|
11330
|
+
"x-f5xc-description-short": "X-Forwarded-Client-Cert header elements to be added to requests Required: YES.",
|
|
11049
11331
|
"x-f5xc-required-for": {
|
|
11050
11332
|
"minimum_config": false,
|
|
11051
11333
|
"create": false,
|
|
@@ -11054,6 +11336,7 @@
|
|
|
11054
11336
|
}
|
|
11055
11337
|
}
|
|
11056
11338
|
},
|
|
11339
|
+
"x-f5xc-description-short": "X-Forwarded-Client-Cert header elements to be added to requests.",
|
|
11057
11340
|
"x-f5xc-minimum-configuration": {
|
|
11058
11341
|
"description": "Minimum configuration for viewsXfccHeaderKeys",
|
|
11059
11342
|
"required_fields": [
|
|
@@ -11142,6 +11425,7 @@
|
|
|
11142
11425
|
"ves.io.schema.rules.string.max_bytes": "1048576",
|
|
11143
11426
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
11144
11427
|
},
|
|
11428
|
+
"x-f5xc-description-short": "IRule code content, this content will be base64 encoded for preserving formating.",
|
|
11145
11429
|
"x-f5xc-required-for": {
|
|
11146
11430
|
"minimum_config": false,
|
|
11147
11431
|
"create": false,
|
|
@@ -11160,6 +11444,7 @@
|
|
|
11160
11444
|
"x-validation-rules": {
|
|
11161
11445
|
"ves.io.schema.rules.string.max_len": "256"
|
|
11162
11446
|
},
|
|
11447
|
+
"x-f5xc-example": "example-resource",
|
|
11163
11448
|
"minLength": 0,
|
|
11164
11449
|
"x-f5xc-required-for": {
|
|
11165
11450
|
"minimum_config": false,
|
|
@@ -11215,6 +11500,7 @@
|
|
|
11215
11500
|
"title": "Fail_if_referred.",
|
|
11216
11501
|
"format": "boolean",
|
|
11217
11502
|
"x-displayname": "Fail-If-Referred.",
|
|
11503
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
11218
11504
|
"x-f5xc-required-for": {
|
|
11219
11505
|
"minimum_config": false,
|
|
11220
11506
|
"create": false,
|
|
@@ -11239,7 +11525,7 @@
|
|
|
11239
11525
|
},
|
|
11240
11526
|
"x-original-maxLength": 1024,
|
|
11241
11527
|
"x-reconciled-from-discovery": true,
|
|
11242
|
-
"x-reconciled-at": "2026-01-
|
|
11528
|
+
"x-reconciled-at": "2026-01-07T15:52:39.022896+00:00"
|
|
11243
11529
|
},
|
|
11244
11530
|
"namespace": {
|
|
11245
11531
|
"type": "string",
|
|
@@ -11248,6 +11534,7 @@
|
|
|
11248
11534
|
"x-displayname": "Namespace",
|
|
11249
11535
|
"x-ves-example": "Ns1",
|
|
11250
11536
|
"x-f5xc-example": "ns1",
|
|
11537
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
11251
11538
|
"minLength": 0,
|
|
11252
11539
|
"maxLength": 6,
|
|
11253
11540
|
"x-f5xc-required-for": {
|
|
@@ -11258,7 +11545,7 @@
|
|
|
11258
11545
|
},
|
|
11259
11546
|
"x-original-maxLength": 1024,
|
|
11260
11547
|
"x-reconciled-from-discovery": true,
|
|
11261
|
-
"x-reconciled-at": "2026-01-
|
|
11548
|
+
"x-reconciled-at": "2026-01-07T15:52:39.022903+00:00"
|
|
11262
11549
|
}
|
|
11263
11550
|
},
|
|
11264
11551
|
"x-f5xc-minimum-configuration": {
|
|
@@ -11293,6 +11580,7 @@
|
|
|
11293
11580
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
11294
11581
|
},
|
|
11295
11582
|
"x-displayname": "Deleted Referred Objects.",
|
|
11583
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
11296
11584
|
"x-f5xc-required-for": {
|
|
11297
11585
|
"minimum_config": false,
|
|
11298
11586
|
"create": false,
|
|
@@ -11308,6 +11596,7 @@
|
|
|
11308
11596
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
11309
11597
|
},
|
|
11310
11598
|
"x-displayname": "Disabled Referred Objects.",
|
|
11599
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
11311
11600
|
"x-f5xc-required-for": {
|
|
11312
11601
|
"minimum_config": false,
|
|
11313
11602
|
"create": false,
|
|
@@ -11326,6 +11615,7 @@
|
|
|
11326
11615
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
11327
11616
|
},
|
|
11328
11617
|
"x-displayname": "Referring Objects.",
|
|
11618
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
11329
11619
|
"x-f5xc-required-for": {
|
|
11330
11620
|
"minimum_config": false,
|
|
11331
11621
|
"create": false,
|
|
@@ -11347,6 +11637,8 @@
|
|
|
11347
11637
|
"$ref": "#/components/schemas/bigip_iruleStatusObject"
|
|
11348
11638
|
},
|
|
11349
11639
|
"x-displayname": "Status",
|
|
11640
|
+
"x-f5xc-example": "active",
|
|
11641
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
11350
11642
|
"x-f5xc-required-for": {
|
|
11351
11643
|
"minimum_config": false,
|
|
11352
11644
|
"create": false,
|
|
@@ -11356,7 +11648,7 @@
|
|
|
11356
11648
|
"maxLength": 17,
|
|
11357
11649
|
"minLength": 17,
|
|
11358
11650
|
"x-reconciled-from-discovery": true,
|
|
11359
|
-
"x-reconciled-at": "2026-01-
|
|
11651
|
+
"x-reconciled-at": "2026-01-07T15:52:39.022920+00:00"
|
|
11360
11652
|
},
|
|
11361
11653
|
"system_metadata": {
|
|
11362
11654
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -11396,6 +11688,8 @@
|
|
|
11396
11688
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
11397
11689
|
],
|
|
11398
11690
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
11691
|
+
"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...",
|
|
11692
|
+
"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...",
|
|
11399
11693
|
"x-f5xc-minimum-configuration": {
|
|
11400
11694
|
"description": "Minimum configuration for bigip_iruleGetResponseFormatCode",
|
|
11401
11695
|
"required_fields": [],
|
|
@@ -11427,6 +11721,7 @@
|
|
|
11427
11721
|
"ves.io.schema.rules.string.max_bytes": "1048576",
|
|
11428
11722
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
11429
11723
|
},
|
|
11724
|
+
"x-f5xc-description-short": "IRule code content, this content will be base64 encoded for preserving formating.",
|
|
11430
11725
|
"x-f5xc-required-for": {
|
|
11431
11726
|
"minimum_config": false,
|
|
11432
11727
|
"create": false,
|
|
@@ -11445,6 +11740,7 @@
|
|
|
11445
11740
|
"x-validation-rules": {
|
|
11446
11741
|
"ves.io.schema.rules.string.max_len": "256"
|
|
11447
11742
|
},
|
|
11743
|
+
"x-f5xc-example": "example-resource",
|
|
11448
11744
|
"minLength": 0,
|
|
11449
11745
|
"x-f5xc-required-for": {
|
|
11450
11746
|
"minimum_config": false,
|
|
@@ -11502,6 +11798,7 @@
|
|
|
11502
11798
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
11503
11799
|
},
|
|
11504
11800
|
"x-displayname": "Errors",
|
|
11801
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
11505
11802
|
"x-f5xc-required-for": {
|
|
11506
11803
|
"minimum_config": false,
|
|
11507
11804
|
"create": false,
|
|
@@ -11517,6 +11814,8 @@
|
|
|
11517
11814
|
"$ref": "#/components/schemas/bigip_iruleListResponseItem"
|
|
11518
11815
|
},
|
|
11519
11816
|
"x-displayname": "Items",
|
|
11817
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
11818
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
11520
11819
|
"x-f5xc-required-for": {
|
|
11521
11820
|
"minimum_config": false,
|
|
11522
11821
|
"create": false,
|
|
@@ -11550,6 +11849,8 @@
|
|
|
11550
11849
|
"description": "The set of annotations present on this bigip_irule.",
|
|
11551
11850
|
"title": "Annotations.",
|
|
11552
11851
|
"x-displayname": "Annotations.",
|
|
11852
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
11853
|
+
"x-f5xc-description-short": "The set of annotations present on this bigip_irule.",
|
|
11553
11854
|
"x-f5xc-required-for": {
|
|
11554
11855
|
"minimum_config": false,
|
|
11555
11856
|
"create": false,
|
|
@@ -11562,6 +11863,7 @@
|
|
|
11562
11863
|
"description": "The description set for this bigip_irule.",
|
|
11563
11864
|
"title": "Description.",
|
|
11564
11865
|
"x-displayname": "Description.",
|
|
11866
|
+
"x-f5xc-description-short": "The description set for this bigip_irule.",
|
|
11565
11867
|
"minLength": 0,
|
|
11566
11868
|
"maxLength": 0,
|
|
11567
11869
|
"x-f5xc-required-for": {
|
|
@@ -11572,7 +11874,7 @@
|
|
|
11572
11874
|
},
|
|
11573
11875
|
"x-original-maxLength": 1024,
|
|
11574
11876
|
"x-reconciled-from-discovery": true,
|
|
11575
|
-
"x-reconciled-at": "2026-01-
|
|
11877
|
+
"x-reconciled-at": "2026-01-07T15:52:39.022939+00:00"
|
|
11576
11878
|
},
|
|
11577
11879
|
"disabled": {
|
|
11578
11880
|
"type": "boolean",
|
|
@@ -11580,6 +11882,8 @@
|
|
|
11580
11882
|
"title": "Disabled",
|
|
11581
11883
|
"format": "boolean",
|
|
11582
11884
|
"x-displayname": "Disabled",
|
|
11885
|
+
"x-f5xc-example": "True",
|
|
11886
|
+
"x-f5xc-description-short": "Value of true indicates bigip_irule is administratively disabled.",
|
|
11583
11887
|
"x-f5xc-required-for": {
|
|
11584
11888
|
"minimum_config": false,
|
|
11585
11889
|
"create": false,
|
|
@@ -11595,6 +11899,8 @@
|
|
|
11595
11899
|
"description": "The set of labels present on this bigip_irule.",
|
|
11596
11900
|
"title": "Labels",
|
|
11597
11901
|
"x-displayname": "Labels",
|
|
11902
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
11903
|
+
"x-f5xc-description-short": "The set of labels present on this bigip_irule.",
|
|
11598
11904
|
"x-f5xc-required-for": {
|
|
11599
11905
|
"minimum_config": false,
|
|
11600
11906
|
"create": false,
|
|
@@ -11622,7 +11928,7 @@
|
|
|
11622
11928
|
},
|
|
11623
11929
|
"x-original-maxLength": 1024,
|
|
11624
11930
|
"x-reconciled-from-discovery": true,
|
|
11625
|
-
"x-reconciled-at": "2026-01-
|
|
11931
|
+
"x-reconciled-at": "2026-01-07T15:52:39.022950+00:00"
|
|
11626
11932
|
},
|
|
11627
11933
|
"namespace": {
|
|
11628
11934
|
"type": "string",
|
|
@@ -11641,7 +11947,7 @@
|
|
|
11641
11947
|
},
|
|
11642
11948
|
"x-original-maxLength": 1024,
|
|
11643
11949
|
"x-reconciled-from-discovery": true,
|
|
11644
|
-
"x-reconciled-at": "2026-01-
|
|
11950
|
+
"x-reconciled-at": "2026-01-07T15:52:39.022955+00:00"
|
|
11645
11951
|
},
|
|
11646
11952
|
"owner_view": {
|
|
11647
11953
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -11654,6 +11960,7 @@
|
|
|
11654
11960
|
"$ref": "#/components/schemas/bigip_iruleStatusObject"
|
|
11655
11961
|
},
|
|
11656
11962
|
"x-displayname": "Status",
|
|
11963
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
11657
11964
|
"x-f5xc-required-for": {
|
|
11658
11965
|
"minimum_config": false,
|
|
11659
11966
|
"create": false,
|
|
@@ -11682,7 +11989,7 @@
|
|
|
11682
11989
|
"x-field-mutability": "read-only",
|
|
11683
11990
|
"x-original-maxLength": 1024,
|
|
11684
11991
|
"x-reconciled-from-discovery": true,
|
|
11685
|
-
"x-reconciled-at": "2026-01-
|
|
11992
|
+
"x-reconciled-at": "2026-01-07T15:52:39.022963+00:00"
|
|
11686
11993
|
},
|
|
11687
11994
|
"uid": {
|
|
11688
11995
|
"type": "string",
|
|
@@ -11703,9 +12010,11 @@
|
|
|
11703
12010
|
"x-original-maxLength": 1024,
|
|
11704
12011
|
"format": "uuid",
|
|
11705
12012
|
"x-reconciled-from-discovery": true,
|
|
11706
|
-
"x-reconciled-at": "2026-01-
|
|
12013
|
+
"x-reconciled-at": "2026-01-07T15:52:39.022968+00:00"
|
|
11707
12014
|
}
|
|
11708
12015
|
},
|
|
12016
|
+
"x-f5xc-description-short": "By default a summary of bigip_irule is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
12017
|
+
"x-f5xc-description-medium": "By default a summary of bigip_irule is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
11709
12018
|
"x-f5xc-minimum-configuration": {
|
|
11710
12019
|
"description": "Minimum configuration for bigip_iruleListResponseItem",
|
|
11711
12020
|
"required_fields": [
|
|
@@ -11791,6 +12100,7 @@
|
|
|
11791
12100
|
"ves.io.schema.rules.string.max_bytes": "1048576",
|
|
11792
12101
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
11793
12102
|
},
|
|
12103
|
+
"x-f5xc-description-short": "IRule code content, this content will be base64 encoded for preserving formating.",
|
|
11794
12104
|
"x-f5xc-required-for": {
|
|
11795
12105
|
"minimum_config": false,
|
|
11796
12106
|
"create": false,
|
|
@@ -11809,6 +12119,7 @@
|
|
|
11809
12119
|
"x-validation-rules": {
|
|
11810
12120
|
"ves.io.schema.rules.string.max_len": "256"
|
|
11811
12121
|
},
|
|
12122
|
+
"x-f5xc-example": "example-resource",
|
|
11812
12123
|
"minLength": 0,
|
|
11813
12124
|
"x-f5xc-required-for": {
|
|
11814
12125
|
"minimum_config": false,
|
|
@@ -11866,6 +12177,7 @@
|
|
|
11866
12177
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
11867
12178
|
},
|
|
11868
12179
|
"x-displayname": "Conditions.",
|
|
12180
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
11869
12181
|
"x-f5xc-required-for": {
|
|
11870
12182
|
"minimum_config": false,
|
|
11871
12183
|
"create": false,
|
|
@@ -11884,6 +12196,7 @@
|
|
|
11884
12196
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
11885
12197
|
},
|
|
11886
12198
|
"x-displayname": "Config Object.",
|
|
12199
|
+
"x-f5xc-description-short": "Reference to the object for current status.",
|
|
11887
12200
|
"x-f5xc-required-for": {
|
|
11888
12201
|
"minimum_config": false,
|
|
11889
12202
|
"create": false,
|
|
@@ -11892,6 +12205,7 @@
|
|
|
11892
12205
|
}
|
|
11893
12206
|
}
|
|
11894
12207
|
},
|
|
12208
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
11895
12209
|
"x-f5xc-minimum-configuration": {
|
|
11896
12210
|
"description": "Minimum configuration for bigip_iruleStatusObject",
|
|
11897
12211
|
"required_fields": [
|
|
@@ -11920,6 +12234,8 @@
|
|
|
11920
12234
|
"x-displayname": "Kind",
|
|
11921
12235
|
"x-ves-example": "Virtual_site.",
|
|
11922
12236
|
"x-f5xc-example": "virtual_site",
|
|
12237
|
+
"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\")",
|
|
12238
|
+
"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\").",
|
|
11923
12239
|
"minLength": 0,
|
|
11924
12240
|
"maxLength": 14,
|
|
11925
12241
|
"x-f5xc-required-for": {
|
|
@@ -11931,7 +12247,7 @@
|
|
|
11931
12247
|
"readOnly": true,
|
|
11932
12248
|
"x-original-maxLength": 1024,
|
|
11933
12249
|
"x-reconciled-from-discovery": true,
|
|
11934
|
-
"x-reconciled-at": "2026-01-
|
|
12250
|
+
"x-reconciled-at": "2026-01-07T15:52:39.023059+00:00"
|
|
11935
12251
|
},
|
|
11936
12252
|
"name": {
|
|
11937
12253
|
"type": "string",
|
|
@@ -11940,6 +12256,8 @@
|
|
|
11940
12256
|
"x-displayname": "Name",
|
|
11941
12257
|
"x-ves-example": "Contactus-route.",
|
|
11942
12258
|
"x-f5xc-example": "contactus-route",
|
|
12259
|
+
"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.",
|
|
12260
|
+
"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.",
|
|
11943
12261
|
"minLength": 0,
|
|
11944
12262
|
"maxLength": 16,
|
|
11945
12263
|
"x-f5xc-required-for": {
|
|
@@ -11950,7 +12268,7 @@
|
|
|
11950
12268
|
},
|
|
11951
12269
|
"x-original-maxLength": 1024,
|
|
11952
12270
|
"x-reconciled-from-discovery": true,
|
|
11953
|
-
"x-reconciled-at": "2026-01-
|
|
12271
|
+
"x-reconciled-at": "2026-01-07T15:52:39.023063+00:00"
|
|
11954
12272
|
},
|
|
11955
12273
|
"namespace": {
|
|
11956
12274
|
"type": "string",
|
|
@@ -11959,6 +12277,8 @@
|
|
|
11959
12277
|
"x-displayname": "Namespace",
|
|
11960
12278
|
"x-ves-example": "Ns1",
|
|
11961
12279
|
"x-f5xc-example": "ns1",
|
|
12280
|
+
"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.",
|
|
12281
|
+
"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.",
|
|
11962
12282
|
"minLength": 0,
|
|
11963
12283
|
"maxLength": 6,
|
|
11964
12284
|
"x-f5xc-required-for": {
|
|
@@ -11969,7 +12289,7 @@
|
|
|
11969
12289
|
},
|
|
11970
12290
|
"x-original-maxLength": 1024,
|
|
11971
12291
|
"x-reconciled-from-discovery": true,
|
|
11972
|
-
"x-reconciled-at": "2026-01-
|
|
12292
|
+
"x-reconciled-at": "2026-01-07T15:52:39.023067+00:00"
|
|
11973
12293
|
},
|
|
11974
12294
|
"tenant": {
|
|
11975
12295
|
"type": "string",
|
|
@@ -11978,6 +12298,8 @@
|
|
|
11978
12298
|
"x-displayname": "Tenant",
|
|
11979
12299
|
"x-ves-example": "Example-corp.",
|
|
11980
12300
|
"x-f5xc-example": "example-corp",
|
|
12301
|
+
"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.",
|
|
12302
|
+
"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.",
|
|
11981
12303
|
"minLength": 0,
|
|
11982
12304
|
"maxLength": 18,
|
|
11983
12305
|
"x-f5xc-required-for": {
|
|
@@ -11990,7 +12312,7 @@
|
|
|
11990
12312
|
"x-field-mutability": "read-only",
|
|
11991
12313
|
"x-original-maxLength": 1024,
|
|
11992
12314
|
"x-reconciled-from-discovery": true,
|
|
11993
|
-
"x-reconciled-at": "2026-01-
|
|
12315
|
+
"x-reconciled-at": "2026-01-07T15:52:39.023071+00:00"
|
|
11994
12316
|
},
|
|
11995
12317
|
"uid": {
|
|
11996
12318
|
"type": "string",
|
|
@@ -11999,6 +12321,8 @@
|
|
|
11999
12321
|
"x-displayname": "UID",
|
|
12000
12322
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
12001
12323
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
12324
|
+
"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.",
|
|
12325
|
+
"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.",
|
|
12002
12326
|
"minLength": 0,
|
|
12003
12327
|
"maxLength": 36,
|
|
12004
12328
|
"x-f5xc-required-for": {
|
|
@@ -12012,9 +12336,11 @@
|
|
|
12012
12336
|
"x-original-maxLength": 1024,
|
|
12013
12337
|
"format": "uuid",
|
|
12014
12338
|
"x-reconciled-from-discovery": true,
|
|
12015
|
-
"x-reconciled-at": "2026-01-
|
|
12339
|
+
"x-reconciled-at": "2026-01-07T15:52:39.023076+00:00"
|
|
12016
12340
|
}
|
|
12017
12341
|
},
|
|
12342
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
12343
|
+
"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...",
|
|
12018
12344
|
"x-f5xc-minimum-configuration": {
|
|
12019
12345
|
"description": "Minimum configuration for schemaObjectRefType",
|
|
12020
12346
|
"required_fields": [
|
|
@@ -12042,6 +12368,7 @@
|
|
|
12042
12368
|
"title": "API endpoint path.",
|
|
12043
12369
|
"x-f5xc-example": "/endpoint1",
|
|
12044
12370
|
"x-required": true,
|
|
12371
|
+
"x-f5xc-description-short": "X-displayName: \"API Endpoint\" The rule is applied only for the specified API endpoints.",
|
|
12045
12372
|
"minLength": 0,
|
|
12046
12373
|
"maxLength": 1024,
|
|
12047
12374
|
"x-f5xc-required-for": {
|
|
@@ -12059,6 +12386,7 @@
|
|
|
12059
12386
|
"$ref": "#/components/schemas/schemaHttpMethod"
|
|
12060
12387
|
},
|
|
12061
12388
|
"x-f5xc-example": "['GET', 'POST', 'DELETE']",
|
|
12389
|
+
"x-f5xc-description-short": "X-displayName: \"Methods\" List of methods values to match against. X-required.",
|
|
12062
12390
|
"x-f5xc-required-for": {
|
|
12063
12391
|
"minimum_config": false,
|
|
12064
12392
|
"create": false,
|
|
@@ -12068,6 +12396,7 @@
|
|
|
12068
12396
|
}
|
|
12069
12397
|
},
|
|
12070
12398
|
"x-required": true,
|
|
12399
|
+
"x-f5xc-description-short": "X-displayName: \"API Endpoint\" The rule is applied only for the specified API endpoints.",
|
|
12071
12400
|
"x-f5xc-minimum-configuration": {
|
|
12072
12401
|
"description": "Minimum configuration for app_typeAPIEndpoint",
|
|
12073
12402
|
"required_fields": [
|
|
@@ -12091,6 +12420,7 @@
|
|
|
12091
12420
|
"description": "X-displayName: \"Name\"\nx-required\nBuilt-in rule for sensitive data detection.",
|
|
12092
12421
|
"title": "Name",
|
|
12093
12422
|
"x-f5xc-example": "[EMAIL, CC]",
|
|
12423
|
+
"x-f5xc-description-short": "X-displayName: \"Name\" x-required Built-in rule for sensitive data detection.",
|
|
12094
12424
|
"minLength": 0,
|
|
12095
12425
|
"maxLength": 16,
|
|
12096
12426
|
"x-f5xc-required-for": {
|
|
@@ -12101,10 +12431,11 @@
|
|
|
12101
12431
|
},
|
|
12102
12432
|
"x-original-maxLength": 1024,
|
|
12103
12433
|
"x-reconciled-from-discovery": true,
|
|
12104
|
-
"x-reconciled-at": "2026-01-
|
|
12434
|
+
"x-reconciled-at": "2026-01-07T15:52:39.539751+00:00"
|
|
12105
12435
|
}
|
|
12106
12436
|
},
|
|
12107
12437
|
"x-f5xc-example": "[EMAIL, CC]",
|
|
12438
|
+
"x-f5xc-description-short": "X-displayName: \"Built-In Sensitive Data Type\" Message wrapper for built-in sensitive data type.",
|
|
12108
12439
|
"x-f5xc-minimum-configuration": {
|
|
12109
12440
|
"description": "Minimum configuration for app_typeBuiltInSensitiveDataType",
|
|
12110
12441
|
"required_fields": [
|
|
@@ -12145,6 +12476,8 @@
|
|
|
12145
12476
|
"description": "X-displayName: \"API Group\"\nThe rule is applied on the APIs that belong to specified api_group.\nAPI groups derived from API Definition swaggers.\nFor example oas-all-operations including all paths and methods from the swaggers, oas-base-URLs covering all requests under base-paths from the swaggers.\nCustom groups can be created if user tags paths or operations with \"x-F5 Distributed Cloud-API-group\" extensions inside swaggers.",
|
|
12146
12477
|
"title": "Api_group",
|
|
12147
12478
|
"x-f5xc-example": "oas-all-operations",
|
|
12479
|
+
"x-f5xc-description-short": "X-displayName: \"API Group\" The rule is applied on the APIs that belong to specified api_group.",
|
|
12480
|
+
"x-f5xc-description-medium": "X-displayName: \"API Group\" The rule is applied on the APIs that belong to specified api_group. API groups derived from API Definition swaggers. For example oas-all-operations including all paths and methods from the swaggers, oas-base-URLs covering all requests under base-paths from the swaggers.",
|
|
12148
12481
|
"minLength": 0,
|
|
12149
12482
|
"maxLength": 1024,
|
|
12150
12483
|
"x-f5xc-required-for": {
|
|
@@ -12159,6 +12492,8 @@
|
|
|
12159
12492
|
"description": "X-displayName: \"Base Path\"\nThe rule is applied only for the requests matching the specified base path.",
|
|
12160
12493
|
"title": "Base path",
|
|
12161
12494
|
"x-f5xc-example": "/v1",
|
|
12495
|
+
"x-f5xc-description-short": "X-displayName: \"Base Path\" The rule is applied only for the requests matching the specified base path.",
|
|
12496
|
+
"x-f5xc-description-medium": "X-displayName: \"Base Path\" The rule is applied only for the requests matching the specified base path.",
|
|
12162
12497
|
"minLength": 0,
|
|
12163
12498
|
"maxLength": 1024,
|
|
12164
12499
|
"x-f5xc-required-for": {
|
|
@@ -12182,6 +12517,7 @@
|
|
|
12182
12517
|
"description": "X-displayName: \"Specific Domain\"\nThe rule will apply for a specific domain.\nFor example: api.example.com.",
|
|
12183
12518
|
"title": "Domain",
|
|
12184
12519
|
"x-f5xc-example": "api.example.com",
|
|
12520
|
+
"x-f5xc-description-short": "X-displayName: \"Specific Domain\" The rule will apply for a specific domain. For",
|
|
12185
12521
|
"minLength": 0,
|
|
12186
12522
|
"maxLength": 1024,
|
|
12187
12523
|
"x-f5xc-required-for": {
|
|
@@ -12195,6 +12531,8 @@
|
|
|
12195
12531
|
"$ref": "#/components/schemas/app_typeValuePattern"
|
|
12196
12532
|
}
|
|
12197
12533
|
},
|
|
12534
|
+
"x-f5xc-description-short": "X-displayName: \"Custom Data Detection Config\" The custom data detection config specifies targets, scopes & the pattern to be detected.",
|
|
12535
|
+
"x-f5xc-description-medium": "X-displayName: \"Custom Data Detection Config\" The custom data detection config specifies targets, scopes & the pattern to be detected.",
|
|
12198
12536
|
"x-f5xc-minimum-configuration": {
|
|
12199
12537
|
"description": "Minimum configuration for app_typeCustomDataDetectionConfig",
|
|
12200
12538
|
"required_fields": [
|
|
@@ -12231,6 +12569,7 @@
|
|
|
12231
12569
|
"items": {
|
|
12232
12570
|
"$ref": "#/components/schemas/schemaHttpSections"
|
|
12233
12571
|
},
|
|
12572
|
+
"x-f5xc-description-short": "X-displayName: \"Custom Sections\" x-required Request & Response Sections.",
|
|
12234
12573
|
"x-f5xc-required-for": {
|
|
12235
12574
|
"minimum_config": false,
|
|
12236
12575
|
"create": false,
|
|
@@ -12239,6 +12578,7 @@
|
|
|
12239
12578
|
}
|
|
12240
12579
|
}
|
|
12241
12580
|
},
|
|
12581
|
+
"x-f5xc-description-short": "X-displayName: \"Custom Sections\" Request & Response Sections.",
|
|
12242
12582
|
"x-f5xc-minimum-configuration": {
|
|
12243
12583
|
"description": "Minimum configuration for app_typeCustomSections",
|
|
12244
12584
|
"required_fields": [
|
|
@@ -12266,6 +12606,7 @@
|
|
|
12266
12606
|
"$ref": "#/components/schemas/app_typeCustomSensitiveDataType"
|
|
12267
12607
|
}
|
|
12268
12608
|
},
|
|
12609
|
+
"x-f5xc-description-short": "X-displayName: \"Custom Sensitive Data Detection Rule\" Custom Sensitive Data Rule Definition.",
|
|
12269
12610
|
"x-f5xc-minimum-configuration": {
|
|
12270
12611
|
"description": "Minimum configuration for app_typeCustomSensitiveDataDetectionRule",
|
|
12271
12612
|
"required_fields": [
|
|
@@ -12291,6 +12632,7 @@
|
|
|
12291
12632
|
"title": "Sensitive data type.",
|
|
12292
12633
|
"x-f5xc-example": "EMAIL",
|
|
12293
12634
|
"x-required": true,
|
|
12635
|
+
"x-f5xc-description-short": "X-displayName: \"Type\" The request is labeled as specified sensitive data type.",
|
|
12294
12636
|
"minLength": 0,
|
|
12295
12637
|
"maxLength": 1024,
|
|
12296
12638
|
"x-f5xc-required-for": {
|
|
@@ -12301,6 +12643,8 @@
|
|
|
12301
12643
|
}
|
|
12302
12644
|
}
|
|
12303
12645
|
},
|
|
12646
|
+
"x-f5xc-description-short": "X-displayName: \"Custom Sensitive Data Type\" The type/category of the sensitive data this rule detects.",
|
|
12647
|
+
"x-f5xc-description-medium": "X-displayName: \"Custom Sensitive Data Type\" The type/category of the sensitive data this rule detects. E.g. Email, Credit Card etc.",
|
|
12304
12648
|
"x-f5xc-minimum-configuration": {
|
|
12305
12649
|
"description": "Minimum configuration for app_typeCustomSensitiveDataType",
|
|
12306
12650
|
"required_fields": [
|
|
@@ -12336,6 +12680,7 @@
|
|
|
12336
12680
|
"ves.io.schema.rules.uint32.gte": "1",
|
|
12337
12681
|
"ves.io.schema.rules.uint32.lte": "7"
|
|
12338
12682
|
},
|
|
12683
|
+
"x-f5xc-description-short": "Inactive discovered API will be deleted after configured duration.",
|
|
12339
12684
|
"minimum": 0,
|
|
12340
12685
|
"maximum": 2147483647,
|
|
12341
12686
|
"x-f5xc-required-for": {
|
|
@@ -12369,6 +12714,7 @@
|
|
|
12369
12714
|
"description": "X-displayName: \"Exact Value\"\nSearch for values with exact match.",
|
|
12370
12715
|
"title": "Exact value.",
|
|
12371
12716
|
"x-f5xc-example": "x-volt-header",
|
|
12717
|
+
"x-f5xc-description-short": "X-displayName: \"Exact Value\" Search for values with exact match.",
|
|
12372
12718
|
"minLength": 0,
|
|
12373
12719
|
"maxLength": 1024,
|
|
12374
12720
|
"x-f5xc-required-for": {
|
|
@@ -12383,6 +12729,7 @@
|
|
|
12383
12729
|
"description": "X-displayName: \"Regex Value\"\nSearch for values matching this regular expression.",
|
|
12384
12730
|
"title": "Regex value.",
|
|
12385
12731
|
"x-f5xc-example": "'^new.*$', 'san f.*', '.* del .*'",
|
|
12732
|
+
"x-f5xc-description-short": "X-displayName: \"Regex Value\" Search for values matching this regular expression.",
|
|
12386
12733
|
"minLength": 0,
|
|
12387
12734
|
"maxLength": 1024,
|
|
12388
12735
|
"x-f5xc-required-for": {
|
|
@@ -12393,6 +12740,7 @@
|
|
|
12393
12740
|
}
|
|
12394
12741
|
}
|
|
12395
12742
|
},
|
|
12743
|
+
"x-f5xc-description-short": "X-displayName: \"Key Pattern\" Pattern to detect. Could be exact match or regex match.",
|
|
12396
12744
|
"x-f5xc-minimum-configuration": {
|
|
12397
12745
|
"description": "Minimum configuration for app_typeKeyPattern",
|
|
12398
12746
|
"required_fields": [
|
|
@@ -12418,6 +12766,8 @@
|
|
|
12418
12766
|
"$ref": "#/components/schemas/app_typeValuePattern"
|
|
12419
12767
|
}
|
|
12420
12768
|
},
|
|
12769
|
+
"x-f5xc-description-short": "X-displayName: \"Key & Value Pattern\" Search for specific key & value patterns in the specified sections.",
|
|
12770
|
+
"x-f5xc-description-medium": "X-displayName: \"Key & Value Pattern\" Search for specific key & value patterns in the specified sections.",
|
|
12421
12771
|
"x-f5xc-minimum-configuration": {
|
|
12422
12772
|
"description": "Minimum configuration for app_typeKeyValuePattern",
|
|
12423
12773
|
"required_fields": [
|
|
@@ -12443,6 +12793,9 @@
|
|
|
12443
12793
|
"items": {
|
|
12444
12794
|
"$ref": "#/components/schemas/app_typeCustomSensitiveDataDetectionRule"
|
|
12445
12795
|
},
|
|
12796
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
12797
|
+
"x-f5xc-description-short": "X-displayName: \"Defined Custom Sensitive Data Types\" Rules to detect custom sensitive data in requests and/or responses sections.",
|
|
12798
|
+
"x-f5xc-description-medium": "X-displayName: \"Defined Custom Sensitive Data Types\" Rules to detect custom sensitive data in requests and/or responses sections.",
|
|
12446
12799
|
"x-f5xc-required-for": {
|
|
12447
12800
|
"minimum_config": false,
|
|
12448
12801
|
"create": false,
|
|
@@ -12458,6 +12811,8 @@
|
|
|
12458
12811
|
"$ref": "#/components/schemas/app_typeBuiltInSensitiveDataType"
|
|
12459
12812
|
},
|
|
12460
12813
|
"x-f5xc-example": "[EMAIL, CC]",
|
|
12814
|
+
"x-f5xc-description-short": "X-displayName: \"Disabled Built-In Sensitive Data Types\" List of disabled built-in sensitive data detection rules.",
|
|
12815
|
+
"x-f5xc-description-medium": "X-displayName: \"Disabled Built-In Sensitive Data Types\" List of disabled built-in sensitive data detection rules.",
|
|
12461
12816
|
"x-f5xc-required-for": {
|
|
12462
12817
|
"minimum_config": false,
|
|
12463
12818
|
"create": false,
|
|
@@ -12466,6 +12821,8 @@
|
|
|
12466
12821
|
}
|
|
12467
12822
|
}
|
|
12468
12823
|
},
|
|
12824
|
+
"x-f5xc-description-short": "X-displayName: \"Sensitive Data Detection Rules\" Rules to manage/configure sensitive data detection in requests and/or response sections.",
|
|
12825
|
+
"x-f5xc-description-medium": "X-displayName: \"Sensitive Data Detection Rules\" Rules to manage/configure sensitive data detection in requests and/or response sections.",
|
|
12469
12826
|
"x-f5xc-minimum-configuration": {
|
|
12470
12827
|
"description": "Minimum configuration for app_typeSensitiveDataDetectionRules",
|
|
12471
12828
|
"required_fields": [
|
|
@@ -12489,6 +12846,7 @@
|
|
|
12489
12846
|
"description": "X-displayName: \"Exact Value\"\nPattern value to be detected.",
|
|
12490
12847
|
"title": "Exact value.",
|
|
12491
12848
|
"x-f5xc-example": "x-volt-header",
|
|
12849
|
+
"x-f5xc-description-short": "X-displayName: \"Exact Value\" Pattern value to be detected.",
|
|
12492
12850
|
"minLength": 0,
|
|
12493
12851
|
"maxLength": 1024,
|
|
12494
12852
|
"x-f5xc-required-for": {
|
|
@@ -12503,6 +12861,7 @@
|
|
|
12503
12861
|
"description": "X-displayName: \"Regex Value\"\nRegular expression for this pattern.",
|
|
12504
12862
|
"title": "Regex value.",
|
|
12505
12863
|
"x-f5xc-example": "'^new.*$', 'san f.*', '.* del .*'",
|
|
12864
|
+
"x-f5xc-description-short": "X-displayName: \"Regex Value\" Regular expression for this pattern.",
|
|
12506
12865
|
"minLength": 0,
|
|
12507
12866
|
"maxLength": 1024,
|
|
12508
12867
|
"x-f5xc-required-for": {
|
|
@@ -12513,6 +12872,7 @@
|
|
|
12513
12872
|
}
|
|
12514
12873
|
}
|
|
12515
12874
|
},
|
|
12875
|
+
"x-f5xc-description-short": "X-displayName: \"Value Pattern\" Pattern to detect. Could be exact match or regex match.",
|
|
12516
12876
|
"x-f5xc-minimum-configuration": {
|
|
12517
12877
|
"description": "Minimum configuration for app_typeValuePattern",
|
|
12518
12878
|
"required_fields": [
|
|
@@ -12590,6 +12950,8 @@
|
|
|
12590
12950
|
"BLOCKING"
|
|
12591
12951
|
],
|
|
12592
12952
|
"default": "NONE",
|
|
12953
|
+
"x-f5xc-description-short": "BigIpVirtualServerAWAFEnforcementMode could be of type NONE, ALARM or BLOCKING.",
|
|
12954
|
+
"x-f5xc-description-medium": "BigIpVirtualServerAWAFEnforcementMode could be of type NONE, ALARM or BLOCKING. X-displayName: \"BIG-IP AWAF Enforcement Mode\" Specifies the Virtual Server AWAF enforcement mode - NONE: x-displayName: \"None\" No AWAF Policy attached - MONITORING: x-displayName: \"Monitoring\" AWAF Enforcement...",
|
|
12593
12955
|
"x-f5xc-minimum-configuration": {
|
|
12594
12956
|
"description": "Minimum configuration for bigip_virtual_serverBigIpVirtualServerAWAFEnforcementMode",
|
|
12595
12957
|
"required_fields": [],
|
|
@@ -12610,6 +12972,8 @@
|
|
|
12610
12972
|
"default": "INVALID_VIRTUAL_SERVER",
|
|
12611
12973
|
"x-displayname": "Virtual Server Type.",
|
|
12612
12974
|
"x-ves-proto-enum": "ves.io.schema.views.bigip_virtual_server.BigIpVirtualServerType",
|
|
12975
|
+
"x-f5xc-description-short": "VirtualServerType could be of type classic BIG-IP or BIG-IP-NEXT. BIG-IP-NEXT will be added later.",
|
|
12976
|
+
"x-f5xc-description-medium": "VirtualServerType could be of type classic BIG-IP or BIG-IP-NEXT. BIG-IP-NEXT will be added later. Specifies the virtual server type Invalid Virtual Server Type Classic BIG-IP Virtual Server.",
|
|
12613
12977
|
"x-f5xc-minimum-configuration": {
|
|
12614
12978
|
"description": "Minimum configuration for bigip_virtual_serverBigIpVirtualServerType",
|
|
12615
12979
|
"required_fields": [],
|
|
@@ -12635,6 +12999,7 @@
|
|
|
12635
12999
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
12636
13000
|
},
|
|
12637
13001
|
"x-displayname": "Deleted Referred Objects.",
|
|
13002
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
12638
13003
|
"x-f5xc-required-for": {
|
|
12639
13004
|
"minimum_config": false,
|
|
12640
13005
|
"create": false,
|
|
@@ -12650,6 +13015,7 @@
|
|
|
12650
13015
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
12651
13016
|
},
|
|
12652
13017
|
"x-displayname": "Disabled Referred Objects.",
|
|
13018
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
12653
13019
|
"x-f5xc-required-for": {
|
|
12654
13020
|
"minimum_config": false,
|
|
12655
13021
|
"create": false,
|
|
@@ -12668,6 +13034,7 @@
|
|
|
12668
13034
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
12669
13035
|
},
|
|
12670
13036
|
"x-displayname": "Referring Objects.",
|
|
13037
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
12671
13038
|
"x-f5xc-required-for": {
|
|
12672
13039
|
"minimum_config": false,
|
|
12673
13040
|
"create": false,
|
|
@@ -12689,6 +13056,8 @@
|
|
|
12689
13056
|
"$ref": "#/components/schemas/bigip_virtual_serverStatusObject"
|
|
12690
13057
|
},
|
|
12691
13058
|
"x-displayname": "Status",
|
|
13059
|
+
"x-f5xc-example": "active",
|
|
13060
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
12692
13061
|
"x-f5xc-required-for": {
|
|
12693
13062
|
"minimum_config": false,
|
|
12694
13063
|
"create": false,
|
|
@@ -12698,7 +13067,7 @@
|
|
|
12698
13067
|
"maxLength": 17,
|
|
12699
13068
|
"minLength": 17,
|
|
12700
13069
|
"x-reconciled-from-discovery": true,
|
|
12701
|
-
"x-reconciled-at": "2026-01-
|
|
13070
|
+
"x-reconciled-at": "2026-01-07T15:52:39.539806+00:00"
|
|
12702
13071
|
},
|
|
12703
13072
|
"system_metadata": {
|
|
12704
13073
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -12736,6 +13105,8 @@
|
|
|
12736
13105
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
12737
13106
|
],
|
|
12738
13107
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
13108
|
+
"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...",
|
|
13109
|
+
"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_REPLACE: x-displayName: \"Replace request format\" Response should...",
|
|
12739
13110
|
"x-f5xc-minimum-configuration": {
|
|
12740
13111
|
"description": "Minimum configuration for bigip_virtual_serverGetResponseFormatCode",
|
|
12741
13112
|
"required_fields": [],
|
|
@@ -12774,6 +13145,7 @@
|
|
|
12774
13145
|
"x-validation-rules": {
|
|
12775
13146
|
"ves.io.schema.rules.message.required": "true"
|
|
12776
13147
|
},
|
|
13148
|
+
"x-f5xc-description-short": "Namespace of the BIG-IP Load Balancer for current request Required: YES.",
|
|
12777
13149
|
"minLength": 0,
|
|
12778
13150
|
"maxLength": 6,
|
|
12779
13151
|
"x-f5xc-required-for": {
|
|
@@ -12784,9 +13156,10 @@
|
|
|
12784
13156
|
},
|
|
12785
13157
|
"x-original-maxLength": 1024,
|
|
12786
13158
|
"x-reconciled-from-discovery": true,
|
|
12787
|
-
"x-reconciled-at": "2026-01-
|
|
13159
|
+
"x-reconciled-at": "2026-01-07T15:52:39.539816+00:00"
|
|
12788
13160
|
}
|
|
12789
13161
|
},
|
|
13162
|
+
"x-f5xc-description-short": "Request of GET Security Config Spec API.",
|
|
12790
13163
|
"x-f5xc-minimum-configuration": {
|
|
12791
13164
|
"description": "Minimum configuration for bigip_virtual_serverGetSecurityConfigReq",
|
|
12792
13165
|
"required_fields": [
|
|
@@ -12816,6 +13189,7 @@
|
|
|
12816
13189
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
12817
13190
|
},
|
|
12818
13191
|
"x-displayname": "Errors",
|
|
13192
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
12819
13193
|
"x-f5xc-required-for": {
|
|
12820
13194
|
"minimum_config": false,
|
|
12821
13195
|
"create": false,
|
|
@@ -12831,6 +13205,8 @@
|
|
|
12831
13205
|
"$ref": "#/components/schemas/bigip_virtual_serverListResponseItem"
|
|
12832
13206
|
},
|
|
12833
13207
|
"x-displayname": "Items",
|
|
13208
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
13209
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
12834
13210
|
"x-f5xc-required-for": {
|
|
12835
13211
|
"minimum_config": false,
|
|
12836
13212
|
"create": false,
|
|
@@ -12864,6 +13240,8 @@
|
|
|
12864
13240
|
"description": "The set of annotations present on this bigip_virtual_server.",
|
|
12865
13241
|
"title": "Annotations.",
|
|
12866
13242
|
"x-displayname": "Annotations.",
|
|
13243
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
13244
|
+
"x-f5xc-description-short": "The set of annotations present on this bigip_virtual_server.",
|
|
12867
13245
|
"x-f5xc-required-for": {
|
|
12868
13246
|
"minimum_config": false,
|
|
12869
13247
|
"create": false,
|
|
@@ -12876,6 +13254,7 @@
|
|
|
12876
13254
|
"description": "The description set for this bigip_virtual_server.",
|
|
12877
13255
|
"title": "Description.",
|
|
12878
13256
|
"x-displayname": "Description.",
|
|
13257
|
+
"x-f5xc-description-short": "The description set for this bigip_virtual_server.",
|
|
12879
13258
|
"minLength": 0,
|
|
12880
13259
|
"maxLength": 0,
|
|
12881
13260
|
"x-f5xc-required-for": {
|
|
@@ -12886,7 +13265,7 @@
|
|
|
12886
13265
|
},
|
|
12887
13266
|
"x-original-maxLength": 1024,
|
|
12888
13267
|
"x-reconciled-from-discovery": true,
|
|
12889
|
-
"x-reconciled-at": "2026-01-
|
|
13268
|
+
"x-reconciled-at": "2026-01-07T15:52:39.539828+00:00"
|
|
12890
13269
|
},
|
|
12891
13270
|
"disabled": {
|
|
12892
13271
|
"type": "boolean",
|
|
@@ -12894,6 +13273,8 @@
|
|
|
12894
13273
|
"title": "Disabled",
|
|
12895
13274
|
"format": "boolean",
|
|
12896
13275
|
"x-displayname": "Disabled",
|
|
13276
|
+
"x-f5xc-example": "True",
|
|
13277
|
+
"x-f5xc-description-short": "Value of true indicates bigip_virtual_server is administratively disabled.",
|
|
12897
13278
|
"x-f5xc-required-for": {
|
|
12898
13279
|
"minimum_config": false,
|
|
12899
13280
|
"create": false,
|
|
@@ -12909,6 +13290,8 @@
|
|
|
12909
13290
|
"description": "The set of labels present on this bigip_virtual_server.",
|
|
12910
13291
|
"title": "Labels",
|
|
12911
13292
|
"x-displayname": "Labels",
|
|
13293
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
13294
|
+
"x-f5xc-description-short": "The set of labels present on this bigip_virtual_server.",
|
|
12912
13295
|
"x-f5xc-required-for": {
|
|
12913
13296
|
"minimum_config": false,
|
|
12914
13297
|
"create": false,
|
|
@@ -12936,7 +13319,7 @@
|
|
|
12936
13319
|
},
|
|
12937
13320
|
"x-original-maxLength": 1024,
|
|
12938
13321
|
"x-reconciled-from-discovery": true,
|
|
12939
|
-
"x-reconciled-at": "2026-01-
|
|
13322
|
+
"x-reconciled-at": "2026-01-07T15:52:39.539838+00:00"
|
|
12940
13323
|
},
|
|
12941
13324
|
"namespace": {
|
|
12942
13325
|
"type": "string",
|
|
@@ -12955,7 +13338,7 @@
|
|
|
12955
13338
|
},
|
|
12956
13339
|
"x-original-maxLength": 1024,
|
|
12957
13340
|
"x-reconciled-from-discovery": true,
|
|
12958
|
-
"x-reconciled-at": "2026-01-
|
|
13341
|
+
"x-reconciled-at": "2026-01-07T15:52:39.539842+00:00"
|
|
12959
13342
|
},
|
|
12960
13343
|
"owner_view": {
|
|
12961
13344
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -12968,6 +13351,7 @@
|
|
|
12968
13351
|
"$ref": "#/components/schemas/bigip_virtual_serverStatusObject"
|
|
12969
13352
|
},
|
|
12970
13353
|
"x-displayname": "Status",
|
|
13354
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
12971
13355
|
"x-f5xc-required-for": {
|
|
12972
13356
|
"minimum_config": false,
|
|
12973
13357
|
"create": false,
|
|
@@ -12996,7 +13380,7 @@
|
|
|
12996
13380
|
"x-field-mutability": "read-only",
|
|
12997
13381
|
"x-original-maxLength": 1024,
|
|
12998
13382
|
"x-reconciled-from-discovery": true,
|
|
12999
|
-
"x-reconciled-at": "2026-01-
|
|
13383
|
+
"x-reconciled-at": "2026-01-07T15:52:39.539851+00:00"
|
|
13000
13384
|
},
|
|
13001
13385
|
"uid": {
|
|
13002
13386
|
"type": "string",
|
|
@@ -13005,6 +13389,7 @@
|
|
|
13005
13389
|
"x-displayname": "UID",
|
|
13006
13390
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
13007
13391
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
13392
|
+
"x-f5xc-description-short": "The unique uid of this bigip_virtual_server.",
|
|
13008
13393
|
"minLength": 0,
|
|
13009
13394
|
"maxLength": 36,
|
|
13010
13395
|
"x-f5xc-required-for": {
|
|
@@ -13017,9 +13402,11 @@
|
|
|
13017
13402
|
"x-original-maxLength": 1024,
|
|
13018
13403
|
"format": "uuid",
|
|
13019
13404
|
"x-reconciled-from-discovery": true,
|
|
13020
|
-
"x-reconciled-at": "2026-01-
|
|
13405
|
+
"x-reconciled-at": "2026-01-07T15:52:39.539857+00:00"
|
|
13021
13406
|
}
|
|
13022
13407
|
},
|
|
13408
|
+
"x-f5xc-description-short": "By default a summary of bigip_virtual_server is returned in 'List'.",
|
|
13409
|
+
"x-f5xc-description-medium": "By default a summary of bigip_virtual_server is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
13023
13410
|
"x-f5xc-minimum-configuration": {
|
|
13024
13411
|
"description": "Minimum configuration for bigip_virtual_serverListResponseItem",
|
|
13025
13412
|
"required_fields": [
|
|
@@ -13099,6 +13486,7 @@
|
|
|
13099
13486
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
13100
13487
|
},
|
|
13101
13488
|
"x-displayname": "Conditions.",
|
|
13489
|
+
"x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.",
|
|
13102
13490
|
"x-f5xc-required-for": {
|
|
13103
13491
|
"minimum_config": false,
|
|
13104
13492
|
"create": false,
|
|
@@ -13117,6 +13505,7 @@
|
|
|
13117
13505
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
13118
13506
|
},
|
|
13119
13507
|
"x-displayname": "Config Object.",
|
|
13508
|
+
"x-f5xc-description-short": "BIG-IP virtual_server view object direct reference.",
|
|
13120
13509
|
"x-f5xc-required-for": {
|
|
13121
13510
|
"minimum_config": false,
|
|
13122
13511
|
"create": false,
|
|
@@ -13125,6 +13514,7 @@
|
|
|
13125
13514
|
}
|
|
13126
13515
|
}
|
|
13127
13516
|
},
|
|
13517
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
13128
13518
|
"x-f5xc-minimum-configuration": {
|
|
13129
13519
|
"description": "Minimum configuration for bigip_virtual_serverStatusObject",
|
|
13130
13520
|
"required_fields": [
|
|
@@ -13152,6 +13542,7 @@
|
|
|
13152
13542
|
"type": "string"
|
|
13153
13543
|
},
|
|
13154
13544
|
"x-displayname": "API Protection Configured.",
|
|
13545
|
+
"description": "API version or group",
|
|
13155
13546
|
"x-f5xc-required-for": {
|
|
13156
13547
|
"minimum_config": false,
|
|
13157
13548
|
"create": false,
|
|
@@ -13166,6 +13557,8 @@
|
|
|
13166
13557
|
"type": "string"
|
|
13167
13558
|
},
|
|
13168
13559
|
"x-displayname": "App Firewall Configured.",
|
|
13560
|
+
"description": "Configuration parameter for app firewall",
|
|
13561
|
+
"x-f5xc-description-short": "Configuration parameter for app firewall.",
|
|
13169
13562
|
"x-f5xc-required-for": {
|
|
13170
13563
|
"minimum_config": false,
|
|
13171
13564
|
"create": false,
|
|
@@ -13180,6 +13573,8 @@
|
|
|
13180
13573
|
"type": "string"
|
|
13181
13574
|
},
|
|
13182
13575
|
"x-displayname": "List of Load Balancers Where App Firewall is Configured Per Route.",
|
|
13576
|
+
"description": "Configuration parameter for app firewall per route",
|
|
13577
|
+
"x-f5xc-description-short": "Configuration parameter for app firewall per route.",
|
|
13183
13578
|
"x-f5xc-required-for": {
|
|
13184
13579
|
"minimum_config": false,
|
|
13185
13580
|
"create": false,
|
|
@@ -13194,6 +13589,8 @@
|
|
|
13194
13589
|
"type": "string"
|
|
13195
13590
|
},
|
|
13196
13591
|
"x-displayname": "Bot Defense Configured.",
|
|
13592
|
+
"description": "Configuration parameter for bot defense",
|
|
13593
|
+
"x-f5xc-description-short": "Configuration parameter for bot defense.",
|
|
13197
13594
|
"x-f5xc-required-for": {
|
|
13198
13595
|
"minimum_config": false,
|
|
13199
13596
|
"create": false,
|
|
@@ -13208,6 +13605,8 @@
|
|
|
13208
13605
|
"type": "string"
|
|
13209
13606
|
},
|
|
13210
13607
|
"x-displayname": "DDoS Detection Configured.",
|
|
13608
|
+
"description": "Configuration parameter for ddos detection",
|
|
13609
|
+
"x-f5xc-description-short": "Configuration parameter for ddos detection.",
|
|
13211
13610
|
"x-f5xc-required-for": {
|
|
13212
13611
|
"minimum_config": false,
|
|
13213
13612
|
"create": false,
|
|
@@ -13222,6 +13621,8 @@
|
|
|
13222
13621
|
"type": "string"
|
|
13223
13622
|
},
|
|
13224
13623
|
"x-displayname": "List of Load Balancers Secured.",
|
|
13624
|
+
"description": "Protection or security configuration",
|
|
13625
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
13225
13626
|
"x-f5xc-required-for": {
|
|
13226
13627
|
"minimum_config": false,
|
|
13227
13628
|
"create": false,
|
|
@@ -13291,6 +13692,7 @@
|
|
|
13291
13692
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
13292
13693
|
}
|
|
13293
13694
|
},
|
|
13695
|
+
"x-f5xc-description-short": "Settings for API specification (API definition, OpenAPI validation, etc.).",
|
|
13294
13696
|
"x-f5xc-minimum-configuration": {
|
|
13295
13697
|
"description": "Minimum configuration for common_wafAPISpecificationSettings",
|
|
13296
13698
|
"required_fields": [
|
|
@@ -13331,6 +13733,7 @@
|
|
|
13331
13733
|
"ves.io.schema.rules.message.required": "true",
|
|
13332
13734
|
"ves.io.schema.rules.string.max_len": "256"
|
|
13333
13735
|
},
|
|
13736
|
+
"x-f5xc-description-short": "Code repository which contain API endpoints Required: YES.",
|
|
13334
13737
|
"x-f5xc-required-for": {
|
|
13335
13738
|
"minimum_config": false,
|
|
13336
13739
|
"create": false,
|
|
@@ -13339,6 +13742,7 @@
|
|
|
13339
13742
|
}
|
|
13340
13743
|
}
|
|
13341
13744
|
},
|
|
13745
|
+
"x-f5xc-description-short": "Select which API repositories represent the LB applications.",
|
|
13342
13746
|
"x-f5xc-minimum-configuration": {
|
|
13343
13747
|
"description": "Minimum configuration for common_wafApiCodeRepos",
|
|
13344
13748
|
"required_fields": [
|
|
@@ -13403,6 +13807,8 @@
|
|
|
13403
13807
|
"ves.io.schema.rules.message.required": "true",
|
|
13404
13808
|
"ves.io.schema.rules.repeated.max_items": "32"
|
|
13405
13809
|
},
|
|
13810
|
+
"x-f5xc-description-short": "Enter domains and their credentials to allow authenticated API crawling.",
|
|
13811
|
+
"x-f5xc-description-medium": "Enter domains and their credentials to allow authenticated API crawling. You can only include domains you own that are associated with this Load Balancer. Required: YES.",
|
|
13406
13812
|
"x-f5xc-required-for": {
|
|
13407
13813
|
"minimum_config": false,
|
|
13408
13814
|
"create": false,
|
|
@@ -13526,6 +13932,7 @@
|
|
|
13526
13932
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
13527
13933
|
}
|
|
13528
13934
|
},
|
|
13935
|
+
"x-f5xc-description-short": "Specifies the settings used for API discovery.",
|
|
13529
13936
|
"x-f5xc-minimum-configuration": {
|
|
13530
13937
|
"description": "Minimum configuration for common_wafApiDiscoverySetting",
|
|
13531
13938
|
"required_fields": [
|
|
@@ -13678,6 +14085,7 @@
|
|
|
13678
14085
|
"ves.io.schema.rules.repeated.max_items": "15",
|
|
13679
14086
|
"ves.io.schema.rules.repeated.unique_metadata_name": "true"
|
|
13680
14087
|
},
|
|
14088
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
13681
14089
|
"x-f5xc-required-for": {
|
|
13682
14090
|
"minimum_config": false,
|
|
13683
14091
|
"create": false,
|
|
@@ -13722,6 +14130,8 @@
|
|
|
13722
14130
|
"ves.io.schema.rules.string.max_len": "256",
|
|
13723
14131
|
"ves.io.schema.rules.string.vh_domain": "true"
|
|
13724
14132
|
},
|
|
14133
|
+
"x-f5xc-example": "example.com",
|
|
14134
|
+
"x-f5xc-description-short": "Select the domain to execute API Crawling with given credentials. Required: YES.",
|
|
13725
14135
|
"minLength": 0,
|
|
13726
14136
|
"x-f5xc-required-for": {
|
|
13727
14137
|
"minimum_config": false,
|
|
@@ -13732,7 +14142,7 @@
|
|
|
13732
14142
|
"x-original-maxLength": 256,
|
|
13733
14143
|
"format": "hostname",
|
|
13734
14144
|
"x-reconciled-from-discovery": true,
|
|
13735
|
-
"x-reconciled-at": "2026-01-
|
|
14145
|
+
"x-reconciled-at": "2026-01-07T15:52:39.539913+00:00"
|
|
13736
14146
|
},
|
|
13737
14147
|
"simple_login": {
|
|
13738
14148
|
"$ref": "#/components/schemas/common_wafSimpleLogin"
|
|
@@ -13786,6 +14196,7 @@
|
|
|
13786
14196
|
"x-validation-rules": {
|
|
13787
14197
|
"ves.io.schema.rules.string.max_len": "128"
|
|
13788
14198
|
},
|
|
14199
|
+
"x-f5xc-description-short": "Exclusive with [api_endpoint base_path] The API group which this validation applies to.",
|
|
13789
14200
|
"minLength": 0,
|
|
13790
14201
|
"x-f5xc-required-for": {
|
|
13791
14202
|
"minimum_config": false,
|
|
@@ -13810,6 +14221,7 @@
|
|
|
13810
14221
|
"ves.io.schema.rules.string.http_path": "true",
|
|
13811
14222
|
"ves.io.schema.rules.string.max_len": "128"
|
|
13812
14223
|
},
|
|
14224
|
+
"x-f5xc-description-short": "Exclusive with [api_endpoint api_group] The base path which this validation applies to.",
|
|
13813
14225
|
"minLength": 0,
|
|
13814
14226
|
"x-f5xc-required-for": {
|
|
13815
14227
|
"minimum_config": false,
|
|
@@ -13822,6 +14234,7 @@
|
|
|
13822
14234
|
"$ref": "#/components/schemas/schemaMessageMetaType"
|
|
13823
14235
|
}
|
|
13824
14236
|
},
|
|
14237
|
+
"x-f5xc-description-short": "Fall Through Rule for a specific endpoint, base-path, or API group.",
|
|
13825
14238
|
"x-f5xc-minimum-configuration": {
|
|
13826
14239
|
"description": "Minimum configuration for common_wafFallThroughRule",
|
|
13827
14240
|
"required_fields": [
|
|
@@ -13856,6 +14269,8 @@
|
|
|
13856
14269
|
}
|
|
13857
14270
|
},
|
|
13858
14271
|
"x-required": true,
|
|
14272
|
+
"x-f5xc-description-short": "Determine what to do with unprotected endpoints (not in the OpenAPI specification file (a.k.a.",
|
|
14273
|
+
"x-f5xc-description-medium": "Determine what to do with unprotected endpoints (not in the OpenAPI specification file (a.k.a. Swagger) or doesn't have a specific rule in custom rules).",
|
|
13859
14274
|
"x-f5xc-minimum-configuration": {
|
|
13860
14275
|
"description": "Minimum configuration for common_wafOpenApiFallThroughMode",
|
|
13861
14276
|
"required_fields": [
|
|
@@ -13924,6 +14339,8 @@
|
|
|
13924
14339
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
13925
14340
|
}
|
|
13926
14341
|
},
|
|
14342
|
+
"x-f5xc-description-short": "OpenAPI specification validation settings relevant for \"API Inventory\" enforcement and for \"Custom list\" enforcement.",
|
|
14343
|
+
"x-f5xc-description-medium": "OpenAPI specification validation settings relevant for \"API Inventory\" enforcement and for \"Custom list\" enforcement.",
|
|
13927
14344
|
"x-f5xc-minimum-configuration": {
|
|
13928
14345
|
"description": "Minimum configuration for common_wafOpenApiValidationCommonSettings",
|
|
13929
14346
|
"required_fields": [
|
|
@@ -13962,6 +14379,8 @@
|
|
|
13962
14379
|
}
|
|
13963
14380
|
},
|
|
13964
14381
|
"x-required": true,
|
|
14382
|
+
"x-f5xc-description-short": "Validation mode of OpenAPI specification.",
|
|
14383
|
+
"x-f5xc-description-medium": "Validation mode of OpenAPI specification. When a validation mismatch occurs on a request to one of the endpoints listed on the OpenAPI specification file (a.k.a. Swagger).",
|
|
13965
14384
|
"x-f5xc-minimum-configuration": {
|
|
13966
14385
|
"description": "Minimum configuration for common_wafOpenApiValidationMode",
|
|
13967
14386
|
"required_fields": [
|
|
@@ -14015,6 +14434,8 @@
|
|
|
14015
14434
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
14016
14435
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
14017
14436
|
},
|
|
14437
|
+
"x-f5xc-description-short": "List of properties of the request to validate according to the OpenAPI specification file (a.k.a.",
|
|
14438
|
+
"x-f5xc-description-medium": "List of properties of the request to validate according to the OpenAPI specification file (a.k.a. Swagger) Required: YES.",
|
|
14018
14439
|
"x-f5xc-required-for": {
|
|
14019
14440
|
"minimum_config": false,
|
|
14020
14441
|
"create": false,
|
|
@@ -14075,6 +14496,8 @@
|
|
|
14075
14496
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
14076
14497
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
14077
14498
|
},
|
|
14499
|
+
"x-f5xc-description-short": "List of properties of the response to validate according to the OpenAPI specification file (a.k.a.",
|
|
14500
|
+
"x-f5xc-description-medium": "List of properties of the response to validate according to the OpenAPI specification file (a.k.a. Swagger) Required: YES.",
|
|
14078
14501
|
"x-f5xc-required-for": {
|
|
14079
14502
|
"minimum_config": false,
|
|
14080
14503
|
"create": false,
|
|
@@ -14126,6 +14549,7 @@
|
|
|
14126
14549
|
"x-validation-rules": {
|
|
14127
14550
|
"ves.io.schema.rules.string.max_len": "128"
|
|
14128
14551
|
},
|
|
14552
|
+
"x-f5xc-description-short": "Exclusive with [api_endpoint base_path] The API group which this validation applies to.",
|
|
14129
14553
|
"minLength": 0,
|
|
14130
14554
|
"x-f5xc-required-for": {
|
|
14131
14555
|
"minimum_config": false,
|
|
@@ -14150,6 +14574,7 @@
|
|
|
14150
14574
|
"ves.io.schema.rules.string.http_path": "true",
|
|
14151
14575
|
"ves.io.schema.rules.string.max_len": "128"
|
|
14152
14576
|
},
|
|
14577
|
+
"x-f5xc-description-short": "Exclusive with [api_endpoint api_group] The base path which this validation applies to.",
|
|
14153
14578
|
"minLength": 0,
|
|
14154
14579
|
"x-f5xc-required-for": {
|
|
14155
14580
|
"minimum_config": false,
|
|
@@ -14175,6 +14600,7 @@
|
|
|
14175
14600
|
"ves.io.schema.rules.string.max_len": "128",
|
|
14176
14601
|
"ves.io.schema.rules.string.vh_domain": "true"
|
|
14177
14602
|
},
|
|
14603
|
+
"x-f5xc-description-short": "Exclusive with [any_domain] The rule will apply for a specific domain.",
|
|
14178
14604
|
"minLength": 0,
|
|
14179
14605
|
"x-f5xc-required-for": {
|
|
14180
14606
|
"minimum_config": false,
|
|
@@ -14187,6 +14613,7 @@
|
|
|
14187
14613
|
"$ref": "#/components/schemas/common_wafOpenApiValidationMode"
|
|
14188
14614
|
}
|
|
14189
14615
|
},
|
|
14616
|
+
"x-f5xc-description-short": "OpenAPI Validation Rule for a specific endpoint, base-path, or API group.",
|
|
14190
14617
|
"x-f5xc-minimum-configuration": {
|
|
14191
14618
|
"description": "Minimum configuration for common_wafOpenApiValidationRule",
|
|
14192
14619
|
"required_fields": [
|
|
@@ -14226,6 +14653,7 @@
|
|
|
14226
14653
|
"x-validation-rules": {
|
|
14227
14654
|
"ves.io.schema.rules.string.max_len": "64"
|
|
14228
14655
|
},
|
|
14656
|
+
"x-f5xc-description-short": "Enter the username to assign credentials for the selected domain to crawl.",
|
|
14229
14657
|
"minLength": 0,
|
|
14230
14658
|
"x-f5xc-required-for": {
|
|
14231
14659
|
"minimum_config": false,
|
|
@@ -14279,6 +14707,7 @@
|
|
|
14279
14707
|
"ves.io.schema.rules.repeated.max_items": "15",
|
|
14280
14708
|
"ves.io.schema.rules.repeated.unique_metadata_name": "true"
|
|
14281
14709
|
},
|
|
14710
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
14282
14711
|
"x-f5xc-required-for": {
|
|
14283
14712
|
"minimum_config": false,
|
|
14284
14713
|
"create": false,
|
|
@@ -14290,6 +14719,8 @@
|
|
|
14290
14719
|
"$ref": "#/components/schemas/common_wafOpenApiValidationCommonSettings"
|
|
14291
14720
|
}
|
|
14292
14721
|
},
|
|
14722
|
+
"x-f5xc-description-short": "Define API groups, base paths, or API endpoints and their OpenAPI validation modes.",
|
|
14723
|
+
"x-f5xc-description-medium": "Define API groups, base paths, or API endpoints and their OpenAPI validation modes. Any other API-endpoint not listed will act according to \"Fall Through Mode\".",
|
|
14293
14724
|
"x-f5xc-minimum-configuration": {
|
|
14294
14725
|
"description": "Minimum configuration for common_wafValidateApiBySpecRule",
|
|
14295
14726
|
"required_fields": [
|
|
@@ -14339,6 +14770,7 @@
|
|
|
14339
14770
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
14340
14771
|
}
|
|
14341
14772
|
},
|
|
14773
|
+
"x-f5xc-description-short": "X-displayName: \"Validation Settings For Headers\" Custom settings for headers validation.",
|
|
14342
14774
|
"x-f5xc-minimum-configuration": {
|
|
14343
14775
|
"description": "Minimum configuration for common_wafValidationSettingForHeaders",
|
|
14344
14776
|
"required_fields": [
|
|
@@ -14367,6 +14799,7 @@
|
|
|
14367
14799
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
14368
14800
|
}
|
|
14369
14801
|
},
|
|
14802
|
+
"x-f5xc-description-short": "Custom settings for query parameters validation.",
|
|
14370
14803
|
"x-f5xc-minimum-configuration": {
|
|
14371
14804
|
"description": "Minimum configuration for common_wafValidationSettingForQueryParameters",
|
|
14372
14805
|
"required_fields": [
|
|
@@ -14400,6 +14833,7 @@
|
|
|
14400
14833
|
"default": "ANY",
|
|
14401
14834
|
"x-displayname": "HTTP Method.",
|
|
14402
14835
|
"x-ves-proto-enum": "ves.io.schema.HttpMethod",
|
|
14836
|
+
"x-f5xc-description-short": "Specifies the HTTP method used to access a resource. Any HTTP Method.",
|
|
14403
14837
|
"x-f5xc-minimum-configuration": {
|
|
14404
14838
|
"description": "Minimum configuration for schemaHttpMethod",
|
|
14405
14839
|
"required_fields": [],
|
|
@@ -14423,6 +14857,8 @@
|
|
|
14423
14857
|
"HTTP_SECTION_RSP_BODY"
|
|
14424
14858
|
],
|
|
14425
14859
|
"default": "HTTP_SECTION_NONE",
|
|
14860
|
+
"x-f5xc-description-short": "X-displayName: \"HTTP Sections\" Request & Response Sections. - HTTP_SECTION_NONE: None ALL_SECTIONS x-displayName: \"None\" ...",
|
|
14861
|
+
"x-f5xc-description-medium": "X-displayName: \"HTTP Sections\" Request & Response Sections. - HTTP_SECTION_NONE: None ALL_SECTIONS x-displayName: \"None\" - HTTP_SECTION_QUERY_PARAMS: QUERY_PARAMS x-displayName: \"Request Query Params\" - HTTP_SECTION_REQ_HEADERS: REQ_HEADERS x-displayName: \"Request Headers\" ...",
|
|
14426
14862
|
"x-f5xc-minimum-configuration": {
|
|
14427
14863
|
"description": "Minimum configuration for schemaHttpSections",
|
|
14428
14864
|
"required_fields": [],
|
|
@@ -14463,7 +14899,7 @@
|
|
|
14463
14899
|
},
|
|
14464
14900
|
"x-original-maxLength": 256,
|
|
14465
14901
|
"x-reconciled-from-discovery": true,
|
|
14466
|
-
"x-reconciled-at": "2026-01-
|
|
14902
|
+
"x-reconciled-at": "2026-01-07T15:52:39.540046+00:00"
|
|
14467
14903
|
},
|
|
14468
14904
|
"name": {
|
|
14469
14905
|
"type": "string",
|
|
@@ -14484,6 +14920,7 @@
|
|
|
14484
14920
|
"ves.io.schema.rules.string.min_len": "1",
|
|
14485
14921
|
"ves.io.schema.rules.string.ves_object_name": "true"
|
|
14486
14922
|
},
|
|
14923
|
+
"x-f5xc-description-short": "Name of the message. The value of name has to follow DNS-1035 format.",
|
|
14487
14924
|
"maxLength": 16,
|
|
14488
14925
|
"x-f5xc-required-for": {
|
|
14489
14926
|
"minimum_config": false,
|
|
@@ -14493,9 +14930,11 @@
|
|
|
14493
14930
|
},
|
|
14494
14931
|
"x-original-maxLength": 1024,
|
|
14495
14932
|
"x-reconciled-from-discovery": true,
|
|
14496
|
-
"x-reconciled-at": "2026-01-
|
|
14933
|
+
"x-reconciled-at": "2026-01-07T15:52:39.540050+00:00"
|
|
14497
14934
|
}
|
|
14498
14935
|
},
|
|
14936
|
+
"x-f5xc-description-short": "MessageMetaType is metadata (common attributes) of a message that only certain messages have.",
|
|
14937
|
+
"x-f5xc-description-medium": "MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create...",
|
|
14499
14938
|
"x-f5xc-minimum-configuration": {
|
|
14500
14939
|
"description": "Minimum configuration for schemaMessageMetaType",
|
|
14501
14940
|
"required_fields": [
|
|
@@ -14526,6 +14965,8 @@
|
|
|
14526
14965
|
"default": "PROPERTY_QUERY_PARAMETERS",
|
|
14527
14966
|
"x-displayname": "OpenAPI Validation Properties.",
|
|
14528
14967
|
"x-ves-proto-enum": "ves.io.schema.OpenApiValidationProperties",
|
|
14968
|
+
"x-f5xc-description-short": "List of required properties to validate against the OpenAPI spec Validate that all query parameters are according to the OpenAPI specification...",
|
|
14969
|
+
"x-f5xc-description-medium": "List of required properties to validate against the OpenAPI spec Validate that all query parameters are according to the OpenAPI specification Validate that all path parameters are according to the OpenAPI specification Validate that the content type of the request is according to the OpenAPI...",
|
|
14529
14970
|
"x-f5xc-minimum-configuration": {
|
|
14530
14971
|
"description": "Minimum configuration for schemaOpenApiValidationProperties",
|
|
14531
14972
|
"required_fields": [],
|
|
@@ -14553,6 +14994,7 @@
|
|
|
14553
14994
|
"type": "string",
|
|
14554
14995
|
"description": "BIG-IP Hostname.",
|
|
14555
14996
|
"x-displayname": "Hostname",
|
|
14997
|
+
"x-f5xc-example": "example-resource",
|
|
14556
14998
|
"minLength": 0,
|
|
14557
14999
|
"maxLength": 1024,
|
|
14558
15000
|
"x-f5xc-required-for": {
|
|
@@ -14576,6 +15018,7 @@
|
|
|
14576
15018
|
"ves.io.schema.rules.message.required": "true",
|
|
14577
15019
|
"ves.io.schema.rules.string.max_len": "256"
|
|
14578
15020
|
},
|
|
15021
|
+
"x-f5xc-description-short": "Version of the BIG-IP which hosts the virtual server Required: YES.",
|
|
14579
15022
|
"minLength": 0,
|
|
14580
15023
|
"x-f5xc-required-for": {
|
|
14581
15024
|
"minimum_config": false,
|
|
@@ -14623,6 +15066,7 @@
|
|
|
14623
15066
|
"x-validation-rules": {
|
|
14624
15067
|
"ves.io.schema.rules.string.max_len": "1024"
|
|
14625
15068
|
},
|
|
15069
|
+
"x-f5xc-example": "example-resource",
|
|
14626
15070
|
"minLength": 0,
|
|
14627
15071
|
"x-f5xc-required-for": {
|
|
14628
15072
|
"minimum_config": false,
|
|
@@ -14638,6 +15082,7 @@
|
|
|
14638
15082
|
"$ref": "#/components/schemas/bigip_virtual_serverBigIpVirtualServerType"
|
|
14639
15083
|
}
|
|
14640
15084
|
},
|
|
15085
|
+
"x-f5xc-description-short": "Shape of the BIG-IP virtual server specification.",
|
|
14641
15086
|
"x-f5xc-minimum-configuration": {
|
|
14642
15087
|
"description": "Minimum configuration for viewsbigip_virtual_serverGetSpecType",
|
|
14643
15088
|
"required_fields": [
|
|
@@ -14690,6 +15135,7 @@
|
|
|
14690
15135
|
"$ref": "#/components/schemas/common_securitySensitiveDataPolicySettings"
|
|
14691
15136
|
}
|
|
14692
15137
|
},
|
|
15138
|
+
"x-f5xc-description-short": "Shape of the BIG-IP virtual server specification.",
|
|
14693
15139
|
"x-f5xc-minimum-configuration": {
|
|
14694
15140
|
"description": "Minimum configuration for viewsbigip_virtual_serverReplaceSpecType",
|
|
14695
15141
|
"required_fields": [
|
|
@@ -14783,6 +15229,7 @@
|
|
|
14783
15229
|
"ves.io.schema.rules.message.required": "true",
|
|
14784
15230
|
"ves.io.schema.rules.string.max_len": "256"
|
|
14785
15231
|
},
|
|
15232
|
+
"x-f5xc-description-short": "Specify Description for iRule Required: YES.",
|
|
14786
15233
|
"minLength": 0,
|
|
14787
15234
|
"x-f5xc-required-for": {
|
|
14788
15235
|
"minimum_config": false,
|
|
@@ -14792,7 +15239,7 @@
|
|
|
14792
15239
|
},
|
|
14793
15240
|
"x-original-maxLength": 256,
|
|
14794
15241
|
"x-reconciled-from-discovery": true,
|
|
14795
|
-
"x-reconciled-at": "2026-01-
|
|
15242
|
+
"x-reconciled-at": "2026-01-07T15:53:05.861571+00:00"
|
|
14796
15243
|
},
|
|
14797
15244
|
"irule": {
|
|
14798
15245
|
"type": "string",
|
|
@@ -14810,6 +15257,7 @@
|
|
|
14810
15257
|
"ves.io.schema.rules.message.required": "true",
|
|
14811
15258
|
"ves.io.schema.rules.string.max_len": "24576"
|
|
14812
15259
|
},
|
|
15260
|
+
"x-f5xc-description-short": "Www.internal.example.f5.com\")} DNS::drop} irule content Required: YES.",
|
|
14813
15261
|
"minLength": 0,
|
|
14814
15262
|
"x-f5xc-required-for": {
|
|
14815
15263
|
"minimum_config": false,
|
|
@@ -14819,6 +15267,7 @@
|
|
|
14819
15267
|
}
|
|
14820
15268
|
}
|
|
14821
15269
|
},
|
|
15270
|
+
"x-f5xc-description-short": "Create iRule in a given namespace. If one already exists it will give an error.",
|
|
14822
15271
|
"x-f5xc-minimum-configuration": {
|
|
14823
15272
|
"description": "Minimum configuration for iruleCreateSpecType",
|
|
14824
15273
|
"required_fields": [
|
|
@@ -14845,6 +15294,7 @@
|
|
|
14845
15294
|
"title": "Fail_if_referred.",
|
|
14846
15295
|
"format": "boolean",
|
|
14847
15296
|
"x-displayname": "Fail-If-Referred.",
|
|
15297
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
14848
15298
|
"x-f5xc-required-for": {
|
|
14849
15299
|
"minimum_config": false,
|
|
14850
15300
|
"create": false,
|
|
@@ -14869,7 +15319,7 @@
|
|
|
14869
15319
|
},
|
|
14870
15320
|
"x-original-maxLength": 1024,
|
|
14871
15321
|
"x-reconciled-from-discovery": true,
|
|
14872
|
-
"x-reconciled-at": "2026-01-
|
|
15322
|
+
"x-reconciled-at": "2026-01-07T15:53:05.861581+00:00"
|
|
14873
15323
|
},
|
|
14874
15324
|
"namespace": {
|
|
14875
15325
|
"type": "string",
|
|
@@ -14878,6 +15328,7 @@
|
|
|
14878
15328
|
"x-displayname": "Namespace",
|
|
14879
15329
|
"x-ves-example": "Ns1",
|
|
14880
15330
|
"x-f5xc-example": "ns1",
|
|
15331
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
14881
15332
|
"minLength": 0,
|
|
14882
15333
|
"maxLength": 6,
|
|
14883
15334
|
"x-f5xc-required-for": {
|
|
@@ -14888,7 +15339,7 @@
|
|
|
14888
15339
|
},
|
|
14889
15340
|
"x-original-maxLength": 1024,
|
|
14890
15341
|
"x-reconciled-from-discovery": true,
|
|
14891
|
-
"x-reconciled-at": "2026-01-
|
|
15342
|
+
"x-reconciled-at": "2026-01-07T15:53:05.861586+00:00"
|
|
14892
15343
|
}
|
|
14893
15344
|
},
|
|
14894
15345
|
"x-f5xc-minimum-configuration": {
|
|
@@ -14923,6 +15374,7 @@
|
|
|
14923
15374
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
14924
15375
|
},
|
|
14925
15376
|
"x-displayname": "Deleted Referred Objects.",
|
|
15377
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
14926
15378
|
"x-f5xc-required-for": {
|
|
14927
15379
|
"minimum_config": false,
|
|
14928
15380
|
"create": false,
|
|
@@ -14938,6 +15390,7 @@
|
|
|
14938
15390
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
14939
15391
|
},
|
|
14940
15392
|
"x-displayname": "Disabled Referred Objects.",
|
|
15393
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
14941
15394
|
"x-f5xc-required-for": {
|
|
14942
15395
|
"minimum_config": false,
|
|
14943
15396
|
"create": false,
|
|
@@ -14956,6 +15409,7 @@
|
|
|
14956
15409
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
14957
15410
|
},
|
|
14958
15411
|
"x-displayname": "Referring Objects.",
|
|
15412
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
14959
15413
|
"x-f5xc-required-for": {
|
|
14960
15414
|
"minimum_config": false,
|
|
14961
15415
|
"create": false,
|
|
@@ -15005,6 +15459,8 @@
|
|
|
15005
15459
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
15006
15460
|
],
|
|
15007
15461
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
15462
|
+
"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...",
|
|
15463
|
+
"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...",
|
|
15008
15464
|
"x-f5xc-minimum-configuration": {
|
|
15009
15465
|
"description": "Minimum configuration for iruleGetResponseFormatCode",
|
|
15010
15466
|
"required_fields": [],
|
|
@@ -15036,6 +15492,7 @@
|
|
|
15036
15492
|
"ves.io.schema.rules.message.required": "true",
|
|
15037
15493
|
"ves.io.schema.rules.string.max_len": "256"
|
|
15038
15494
|
},
|
|
15495
|
+
"x-f5xc-description-short": "Specify Description for iRule Required: YES.",
|
|
15039
15496
|
"minLength": 0,
|
|
15040
15497
|
"x-f5xc-required-for": {
|
|
15041
15498
|
"minimum_config": false,
|
|
@@ -15045,7 +15502,7 @@
|
|
|
15045
15502
|
},
|
|
15046
15503
|
"x-original-maxLength": 256,
|
|
15047
15504
|
"x-reconciled-from-discovery": true,
|
|
15048
|
-
"x-reconciled-at": "2026-01-
|
|
15505
|
+
"x-reconciled-at": "2026-01-07T15:53:05.861601+00:00"
|
|
15049
15506
|
},
|
|
15050
15507
|
"irule": {
|
|
15051
15508
|
"type": "string",
|
|
@@ -15063,6 +15520,7 @@
|
|
|
15063
15520
|
"ves.io.schema.rules.message.required": "true",
|
|
15064
15521
|
"ves.io.schema.rules.string.max_len": "24576"
|
|
15065
15522
|
},
|
|
15523
|
+
"x-f5xc-description-short": "Www.internal.example.f5.com\")} DNS::drop} irule content Required: YES.",
|
|
15066
15524
|
"minLength": 0,
|
|
15067
15525
|
"x-f5xc-required-for": {
|
|
15068
15526
|
"minimum_config": false,
|
|
@@ -15100,6 +15558,7 @@
|
|
|
15100
15558
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
15101
15559
|
},
|
|
15102
15560
|
"x-displayname": "Errors",
|
|
15561
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
15103
15562
|
"x-f5xc-required-for": {
|
|
15104
15563
|
"minimum_config": false,
|
|
15105
15564
|
"create": false,
|
|
@@ -15115,6 +15574,8 @@
|
|
|
15115
15574
|
"$ref": "#/components/schemas/iruleListResponseItem"
|
|
15116
15575
|
},
|
|
15117
15576
|
"x-displayname": "Items",
|
|
15577
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
15578
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
15118
15579
|
"x-f5xc-required-for": {
|
|
15119
15580
|
"minimum_config": false,
|
|
15120
15581
|
"create": false,
|
|
@@ -15148,6 +15609,8 @@
|
|
|
15148
15609
|
"description": "The set of annotations present on this irule.",
|
|
15149
15610
|
"title": "Annotations.",
|
|
15150
15611
|
"x-displayname": "Annotations.",
|
|
15612
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
15613
|
+
"x-f5xc-description-short": "The set of annotations present on this irule.",
|
|
15151
15614
|
"x-f5xc-required-for": {
|
|
15152
15615
|
"minimum_config": false,
|
|
15153
15616
|
"create": false,
|
|
@@ -15170,7 +15633,7 @@
|
|
|
15170
15633
|
},
|
|
15171
15634
|
"x-original-maxLength": 1024,
|
|
15172
15635
|
"x-reconciled-from-discovery": true,
|
|
15173
|
-
"x-reconciled-at": "2026-01-
|
|
15636
|
+
"x-reconciled-at": "2026-01-07T15:53:05.861614+00:00"
|
|
15174
15637
|
},
|
|
15175
15638
|
"disabled": {
|
|
15176
15639
|
"type": "boolean",
|
|
@@ -15178,6 +15641,8 @@
|
|
|
15178
15641
|
"title": "Disabled",
|
|
15179
15642
|
"format": "boolean",
|
|
15180
15643
|
"x-displayname": "Disabled",
|
|
15644
|
+
"x-f5xc-example": "True",
|
|
15645
|
+
"x-f5xc-description-short": "Value of true indicates irule is administratively disabled.",
|
|
15181
15646
|
"x-f5xc-required-for": {
|
|
15182
15647
|
"minimum_config": false,
|
|
15183
15648
|
"create": false,
|
|
@@ -15193,6 +15658,8 @@
|
|
|
15193
15658
|
"description": "The set of labels present on this irule.",
|
|
15194
15659
|
"title": "Labels",
|
|
15195
15660
|
"x-displayname": "Labels",
|
|
15661
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
15662
|
+
"x-f5xc-description-short": "The set of labels present on this irule.",
|
|
15196
15663
|
"x-f5xc-required-for": {
|
|
15197
15664
|
"minimum_config": false,
|
|
15198
15665
|
"create": false,
|
|
@@ -15220,7 +15687,7 @@
|
|
|
15220
15687
|
},
|
|
15221
15688
|
"x-original-maxLength": 1024,
|
|
15222
15689
|
"x-reconciled-from-discovery": true,
|
|
15223
|
-
"x-reconciled-at": "2026-01-
|
|
15690
|
+
"x-reconciled-at": "2026-01-07T15:53:05.861623+00:00"
|
|
15224
15691
|
},
|
|
15225
15692
|
"namespace": {
|
|
15226
15693
|
"type": "string",
|
|
@@ -15239,7 +15706,7 @@
|
|
|
15239
15706
|
},
|
|
15240
15707
|
"x-original-maxLength": 1024,
|
|
15241
15708
|
"x-reconciled-from-discovery": true,
|
|
15242
|
-
"x-reconciled-at": "2026-01-
|
|
15709
|
+
"x-reconciled-at": "2026-01-07T15:53:05.861627+00:00"
|
|
15243
15710
|
},
|
|
15244
15711
|
"owner_view": {
|
|
15245
15712
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -15265,7 +15732,7 @@
|
|
|
15265
15732
|
"x-field-mutability": "read-only",
|
|
15266
15733
|
"x-original-maxLength": 1024,
|
|
15267
15734
|
"x-reconciled-from-discovery": true,
|
|
15268
|
-
"x-reconciled-at": "2026-01-
|
|
15735
|
+
"x-reconciled-at": "2026-01-07T15:53:05.861634+00:00"
|
|
15269
15736
|
},
|
|
15270
15737
|
"uid": {
|
|
15271
15738
|
"type": "string",
|
|
@@ -15286,9 +15753,11 @@
|
|
|
15286
15753
|
"x-original-maxLength": 1024,
|
|
15287
15754
|
"format": "uuid",
|
|
15288
15755
|
"x-reconciled-from-discovery": true,
|
|
15289
|
-
"x-reconciled-at": "2026-01-
|
|
15756
|
+
"x-reconciled-at": "2026-01-07T15:53:05.861639+00:00"
|
|
15290
15757
|
}
|
|
15291
15758
|
},
|
|
15759
|
+
"x-f5xc-description-short": "By default a summary of irule is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
15760
|
+
"x-f5xc-description-medium": "By default a summary of irule is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
15292
15761
|
"x-f5xc-minimum-configuration": {
|
|
15293
15762
|
"description": "Minimum configuration for iruleListResponseItem",
|
|
15294
15763
|
"required_fields": [
|
|
@@ -15373,6 +15842,7 @@
|
|
|
15373
15842
|
"ves.io.schema.rules.message.required": "true",
|
|
15374
15843
|
"ves.io.schema.rules.string.max_len": "256"
|
|
15375
15844
|
},
|
|
15845
|
+
"x-f5xc-description-short": "Specify Description for iRule Required: YES.",
|
|
15376
15846
|
"minLength": 0,
|
|
15377
15847
|
"x-f5xc-required-for": {
|
|
15378
15848
|
"minimum_config": false,
|
|
@@ -15382,7 +15852,7 @@
|
|
|
15382
15852
|
},
|
|
15383
15853
|
"x-original-maxLength": 256,
|
|
15384
15854
|
"x-reconciled-from-discovery": true,
|
|
15385
|
-
"x-reconciled-at": "2026-01-
|
|
15855
|
+
"x-reconciled-at": "2026-01-07T15:53:05.861648+00:00"
|
|
15386
15856
|
},
|
|
15387
15857
|
"irule": {
|
|
15388
15858
|
"type": "string",
|
|
@@ -15400,6 +15870,7 @@
|
|
|
15400
15870
|
"ves.io.schema.rules.message.required": "true",
|
|
15401
15871
|
"ves.io.schema.rules.string.max_len": "24576"
|
|
15402
15872
|
},
|
|
15873
|
+
"x-f5xc-description-short": "Www.internal.example.f5.com\")} DNS::drop} irule content Required: YES.",
|
|
15403
15874
|
"minLength": 0,
|
|
15404
15875
|
"x-f5xc-required-for": {
|
|
15405
15876
|
"minimum_config": false,
|
|
@@ -15440,6 +15911,7 @@
|
|
|
15440
15911
|
"$ref": "#/components/schemas/data_groupStringRecords"
|
|
15441
15912
|
}
|
|
15442
15913
|
},
|
|
15914
|
+
"x-f5xc-description-short": "Create data group in a given namespace. If one already exists it will give an error.",
|
|
15443
15915
|
"x-f5xc-minimum-configuration": {
|
|
15444
15916
|
"description": "Minimum configuration for bigcnedata_groupCreateSpecType",
|
|
15445
15917
|
"required_fields": [
|
|
@@ -15504,6 +15976,7 @@
|
|
|
15504
15976
|
"$ref": "#/components/schemas/data_groupStringRecords"
|
|
15505
15977
|
}
|
|
15506
15978
|
},
|
|
15979
|
+
"x-f5xc-description-short": "Replace Data Group in a given namespace.",
|
|
15507
15980
|
"x-f5xc-minimum-configuration": {
|
|
15508
15981
|
"description": "Minimum configuration for bigcnedata_groupReplaceSpecType",
|
|
15509
15982
|
"required_fields": [
|
|
@@ -15527,7 +16000,7 @@
|
|
|
15527
16000
|
"properties": {
|
|
15528
16001
|
"records": {
|
|
15529
16002
|
"type": "object",
|
|
15530
|
-
"description": "",
|
|
16003
|
+
"description": "Configuration parameter for records",
|
|
15531
16004
|
"title": "Address records.",
|
|
15532
16005
|
"x-displayname": "Address records.",
|
|
15533
16006
|
"x-ves-validation-rules": {
|
|
@@ -15628,6 +16101,7 @@
|
|
|
15628
16101
|
"title": "Fail_if_referred.",
|
|
15629
16102
|
"format": "boolean",
|
|
15630
16103
|
"x-displayname": "Fail-If-Referred.",
|
|
16104
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
15631
16105
|
"x-f5xc-required-for": {
|
|
15632
16106
|
"minimum_config": false,
|
|
15633
16107
|
"create": false,
|
|
@@ -15652,7 +16126,7 @@
|
|
|
15652
16126
|
},
|
|
15653
16127
|
"x-original-maxLength": 1024,
|
|
15654
16128
|
"x-reconciled-from-discovery": true,
|
|
15655
|
-
"x-reconciled-at": "2026-01-
|
|
16129
|
+
"x-reconciled-at": "2026-01-07T15:53:12.543463+00:00"
|
|
15656
16130
|
},
|
|
15657
16131
|
"namespace": {
|
|
15658
16132
|
"type": "string",
|
|
@@ -15661,6 +16135,7 @@
|
|
|
15661
16135
|
"x-displayname": "Namespace",
|
|
15662
16136
|
"x-ves-example": "Ns1",
|
|
15663
16137
|
"x-f5xc-example": "ns1",
|
|
16138
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
15664
16139
|
"minLength": 0,
|
|
15665
16140
|
"maxLength": 6,
|
|
15666
16141
|
"x-f5xc-required-for": {
|
|
@@ -15671,7 +16146,7 @@
|
|
|
15671
16146
|
},
|
|
15672
16147
|
"x-original-maxLength": 1024,
|
|
15673
16148
|
"x-reconciled-from-discovery": true,
|
|
15674
|
-
"x-reconciled-at": "2026-01-
|
|
16149
|
+
"x-reconciled-at": "2026-01-07T15:53:12.543471+00:00"
|
|
15675
16150
|
}
|
|
15676
16151
|
},
|
|
15677
16152
|
"x-f5xc-minimum-configuration": {
|
|
@@ -15706,6 +16181,7 @@
|
|
|
15706
16181
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
15707
16182
|
},
|
|
15708
16183
|
"x-displayname": "Deleted Referred Objects.",
|
|
16184
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
15709
16185
|
"x-f5xc-required-for": {
|
|
15710
16186
|
"minimum_config": false,
|
|
15711
16187
|
"create": false,
|
|
@@ -15721,6 +16197,7 @@
|
|
|
15721
16197
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
15722
16198
|
},
|
|
15723
16199
|
"x-displayname": "Disabled Referred Objects.",
|
|
16200
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
15724
16201
|
"x-f5xc-required-for": {
|
|
15725
16202
|
"minimum_config": false,
|
|
15726
16203
|
"create": false,
|
|
@@ -15739,6 +16216,7 @@
|
|
|
15739
16216
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
15740
16217
|
},
|
|
15741
16218
|
"x-displayname": "Referring Objects.",
|
|
16219
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
15742
16220
|
"x-f5xc-required-for": {
|
|
15743
16221
|
"minimum_config": false,
|
|
15744
16222
|
"create": false,
|
|
@@ -15788,6 +16266,8 @@
|
|
|
15788
16266
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
15789
16267
|
],
|
|
15790
16268
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
16269
|
+
"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...",
|
|
16270
|
+
"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...",
|
|
15791
16271
|
"x-f5xc-minimum-configuration": {
|
|
15792
16272
|
"description": "Minimum configuration for data_groupGetResponseFormatCode",
|
|
15793
16273
|
"required_fields": [],
|
|
@@ -15807,7 +16287,7 @@
|
|
|
15807
16287
|
"properties": {
|
|
15808
16288
|
"records": {
|
|
15809
16289
|
"type": "object",
|
|
15810
|
-
"description": "",
|
|
16290
|
+
"description": "Configuration parameter for records",
|
|
15811
16291
|
"title": "Integer records.",
|
|
15812
16292
|
"x-displayname": "Integer records.",
|
|
15813
16293
|
"x-ves-validation-rules": {
|
|
@@ -15853,6 +16333,7 @@
|
|
|
15853
16333
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
15854
16334
|
},
|
|
15855
16335
|
"x-displayname": "Errors",
|
|
16336
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
15856
16337
|
"x-f5xc-required-for": {
|
|
15857
16338
|
"minimum_config": false,
|
|
15858
16339
|
"create": false,
|
|
@@ -15868,6 +16349,8 @@
|
|
|
15868
16349
|
"$ref": "#/components/schemas/data_groupListResponseItem"
|
|
15869
16350
|
},
|
|
15870
16351
|
"x-displayname": "Items",
|
|
16352
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
16353
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
15871
16354
|
"x-f5xc-required-for": {
|
|
15872
16355
|
"minimum_config": false,
|
|
15873
16356
|
"create": false,
|
|
@@ -15901,6 +16384,8 @@
|
|
|
15901
16384
|
"description": "The set of annotations present on this data_group.",
|
|
15902
16385
|
"title": "Annotations.",
|
|
15903
16386
|
"x-displayname": "Annotations.",
|
|
16387
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
16388
|
+
"x-f5xc-description-short": "The set of annotations present on this data_group.",
|
|
15904
16389
|
"x-f5xc-required-for": {
|
|
15905
16390
|
"minimum_config": false,
|
|
15906
16391
|
"create": false,
|
|
@@ -15913,6 +16398,7 @@
|
|
|
15913
16398
|
"description": "The description set for this data_group.",
|
|
15914
16399
|
"title": "Description.",
|
|
15915
16400
|
"x-displayname": "Description.",
|
|
16401
|
+
"x-f5xc-description-short": "The description set for this data_group.",
|
|
15916
16402
|
"minLength": 0,
|
|
15917
16403
|
"maxLength": 0,
|
|
15918
16404
|
"x-f5xc-required-for": {
|
|
@@ -15923,7 +16409,7 @@
|
|
|
15923
16409
|
},
|
|
15924
16410
|
"x-original-maxLength": 1024,
|
|
15925
16411
|
"x-reconciled-from-discovery": true,
|
|
15926
|
-
"x-reconciled-at": "2026-01-
|
|
16412
|
+
"x-reconciled-at": "2026-01-07T15:53:12.543495+00:00"
|
|
15927
16413
|
},
|
|
15928
16414
|
"disabled": {
|
|
15929
16415
|
"type": "boolean",
|
|
@@ -15931,6 +16417,8 @@
|
|
|
15931
16417
|
"title": "Disabled",
|
|
15932
16418
|
"format": "boolean",
|
|
15933
16419
|
"x-displayname": "Disabled",
|
|
16420
|
+
"x-f5xc-example": "True",
|
|
16421
|
+
"x-f5xc-description-short": "Value of true indicates data_group is administratively disabled.",
|
|
15934
16422
|
"x-f5xc-required-for": {
|
|
15935
16423
|
"minimum_config": false,
|
|
15936
16424
|
"create": false,
|
|
@@ -15946,6 +16434,8 @@
|
|
|
15946
16434
|
"description": "The set of labels present on this data_group.",
|
|
15947
16435
|
"title": "Labels",
|
|
15948
16436
|
"x-displayname": "Labels",
|
|
16437
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
16438
|
+
"x-f5xc-description-short": "The set of labels present on this data_group.",
|
|
15949
16439
|
"x-f5xc-required-for": {
|
|
15950
16440
|
"minimum_config": false,
|
|
15951
16441
|
"create": false,
|
|
@@ -15973,7 +16463,7 @@
|
|
|
15973
16463
|
},
|
|
15974
16464
|
"x-original-maxLength": 1024,
|
|
15975
16465
|
"x-reconciled-from-discovery": true,
|
|
15976
|
-
"x-reconciled-at": "2026-01-
|
|
16466
|
+
"x-reconciled-at": "2026-01-07T15:53:12.543505+00:00"
|
|
15977
16467
|
},
|
|
15978
16468
|
"namespace": {
|
|
15979
16469
|
"type": "string",
|
|
@@ -15992,7 +16482,7 @@
|
|
|
15992
16482
|
},
|
|
15993
16483
|
"x-original-maxLength": 1024,
|
|
15994
16484
|
"x-reconciled-from-discovery": true,
|
|
15995
|
-
"x-reconciled-at": "2026-01-
|
|
16485
|
+
"x-reconciled-at": "2026-01-07T15:53:12.543509+00:00"
|
|
15996
16486
|
},
|
|
15997
16487
|
"owner_view": {
|
|
15998
16488
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -16018,7 +16508,7 @@
|
|
|
16018
16508
|
"x-field-mutability": "read-only",
|
|
16019
16509
|
"x-original-maxLength": 1024,
|
|
16020
16510
|
"x-reconciled-from-discovery": true,
|
|
16021
|
-
"x-reconciled-at": "2026-01-
|
|
16511
|
+
"x-reconciled-at": "2026-01-07T15:53:12.543516+00:00"
|
|
16022
16512
|
},
|
|
16023
16513
|
"uid": {
|
|
16024
16514
|
"type": "string",
|
|
@@ -16039,9 +16529,11 @@
|
|
|
16039
16529
|
"x-original-maxLength": 1024,
|
|
16040
16530
|
"format": "uuid",
|
|
16041
16531
|
"x-reconciled-from-discovery": true,
|
|
16042
|
-
"x-reconciled-at": "2026-01-
|
|
16532
|
+
"x-reconciled-at": "2026-01-07T15:53:12.543521+00:00"
|
|
16043
16533
|
}
|
|
16044
16534
|
},
|
|
16535
|
+
"x-f5xc-description-short": "By default a summary of data_group is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
16536
|
+
"x-f5xc-description-medium": "By default a summary of data_group is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
16045
16537
|
"x-f5xc-minimum-configuration": {
|
|
16046
16538
|
"description": "Minimum configuration for data_groupListResponseItem",
|
|
16047
16539
|
"required_fields": [
|
|
@@ -16114,7 +16606,7 @@
|
|
|
16114
16606
|
"properties": {
|
|
16115
16607
|
"records": {
|
|
16116
16608
|
"type": "object",
|
|
16117
|
-
"description": "",
|
|
16609
|
+
"description": "Configuration parameter for records",
|
|
16118
16610
|
"title": "String records.",
|
|
16119
16611
|
"x-displayname": "String records.",
|
|
16120
16612
|
"x-ves-validation-rules": {
|