@robinmordasiewicz/f5xc-api-mcp 2.0.13-2601051957 → 2.0.19-2601071557
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
- package/dist/tools/generated/ce_management/index.js +179 -1582
- package/dist/tools/generated/ce_management/index.js.map +1 -1
- package/dist/tools/generated/dependency-graph.json +2 -265
- package/dist/version.d.ts +2 -2
- package/dist/version.js +2 -2
- package/manifest.json +1 -1
- package/package.json +1 -1
- package/specs/domains/admin_console_and_ui.json +111 -25
- package/specs/domains/ai_services.json +114 -35
- package/specs/domains/api.json +1082 -177
- package/specs/domains/authentication.json +205 -45
- package/specs/domains/bigip.json +593 -101
- package/specs/domains/billing_and_usage.json +440 -82
- package/specs/domains/blindfold.json +713 -110
- package/specs/domains/bot_and_threat_defense.json +359 -65
- package/specs/domains/cdn.json +2131 -194
- package/specs/domains/ce_management.json +9110 -15844
- package/specs/domains/certificates.json +362 -75
- package/specs/domains/cloud_infrastructure.json +802 -119
- package/specs/domains/container_services.json +613 -95
- package/specs/domains/data_and_privacy_security.json +364 -66
- package/specs/domains/data_intelligence.json +324 -63
- package/specs/domains/ddos.json +766 -159
- package/specs/domains/dns.json +820 -161
- package/specs/domains/managed_kubernetes.json +455 -85
- package/specs/domains/marketplace.json +670 -104
- package/specs/domains/network.json +1620 -238
- package/specs/domains/network_security.json +1401 -191
- package/specs/domains/nginx_one.json +326 -62
- package/specs/domains/object_storage.json +49 -15
- package/specs/domains/observability.json +999 -147
- package/specs/domains/rate_limiting.json +300 -55
- package/specs/domains/secops_and_incident_response.json +189 -36
- package/specs/domains/service_mesh.json +955 -124
- package/specs/domains/shape.json +2150 -397
- package/specs/domains/sites.json +3830 -364
- package/specs/domains/statistics.json +2117 -235
- package/specs/domains/support.json +602 -108
- package/specs/domains/telemetry_and_insights.json +753 -79
- package/specs/domains/tenant_and_identity.json +1874 -308
- package/specs/domains/threat_campaign.json +637 -71
- package/specs/domains/users.json +278 -66
- package/specs/domains/virtual.json +2803 -260
- package/specs/domains/vpm_and_node_management.json +3 -1
- package/specs/domains/waf.json +1125 -148
- package/specs/index.json +24 -24
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Authentication",
|
|
5
5
|
"description": "F5 Distributed Cloud Authentication API specifications",
|
|
6
|
-
"version": "2.0.
|
|
6
|
+
"version": "2.0.19",
|
|
7
7
|
"contact": {
|
|
8
8
|
"name": "F5 Distributed Cloud",
|
|
9
9
|
"url": "https://docs.cloud.f5.com"
|
|
@@ -3898,6 +3898,8 @@
|
|
|
3898
3898
|
"default": "API_CERTIFICATE",
|
|
3899
3899
|
"x-displayname": "Credential Type.",
|
|
3900
3900
|
"x-ves-proto-enum": "ves.io.schema.api_credential.APICredentialType",
|
|
3901
|
+
"x-f5xc-description-short": "Types of API credential given when requesting credentials from F5 Distributed Cloud F5XC user certificate to access F5XC public API using mTLS...",
|
|
3902
|
+
"x-f5xc-description-medium": "Types of API credential given when requesting credentials from F5 Distributed Cloud F5XC user certificate to access F5XC public API using mTLS using self credential (my credential) Kubernetes config file to access Virtual Kubernetes API in F5 Distributed Cloud using self credential (my...",
|
|
3901
3903
|
"x-f5xc-minimum-configuration": {
|
|
3902
3904
|
"description": "Minimum configuration for api_credentialAPICredentialType",
|
|
3903
3905
|
"required_fields": [],
|
|
@@ -3935,6 +3937,8 @@
|
|
|
3935
3937
|
"ves.io.schema.rules.string.max_bytes": "50",
|
|
3936
3938
|
"ves.io.schema.rules.string.min_bytes": "6"
|
|
3937
3939
|
},
|
|
3940
|
+
"x-f5xc-description-short": "Password is used for generating an API certificate P12 bundle user can use to protect access to it.",
|
|
3941
|
+
"x-f5xc-description-medium": "Password is used for generating an API certificate P12 bundle user can use to protect access to it. This password will not be saved/persisted anywhere in the system. Applicable for credential type API_CERTIFICATE Users have to use this password when they use the certificate, e.g.",
|
|
3938
3942
|
"x-f5xc-required-for": {
|
|
3939
3943
|
"minimum_config": false,
|
|
3940
3944
|
"create": false,
|
|
@@ -3970,6 +3974,7 @@
|
|
|
3970
3974
|
"$ref": "#/components/schemas/api_credentialNameSelector"
|
|
3971
3975
|
}
|
|
3972
3976
|
},
|
|
3977
|
+
"x-f5xc-description-short": "Request format for revoking multiple API credentials.",
|
|
3973
3978
|
"x-f5xc-minimum-configuration": {
|
|
3974
3979
|
"description": "Minimum configuration for api_credentialBulkRevokeRequest",
|
|
3975
3980
|
"required_fields": [
|
|
@@ -3998,6 +4003,7 @@
|
|
|
3998
4003
|
"type": "string"
|
|
3999
4004
|
},
|
|
4000
4005
|
"x-displayname": "Credentials Failed.",
|
|
4006
|
+
"x-f5xc-description-short": "Names of credentials that are not marked as DELETE due to some error.",
|
|
4001
4007
|
"x-f5xc-required-for": {
|
|
4002
4008
|
"minimum_config": false,
|
|
4003
4009
|
"create": false,
|
|
@@ -4013,6 +4019,7 @@
|
|
|
4013
4019
|
"type": "string"
|
|
4014
4020
|
},
|
|
4015
4021
|
"x-displayname": "Credentials Success.",
|
|
4022
|
+
"x-f5xc-description-short": "Names of credentials that are successfully marked for deletion.",
|
|
4016
4023
|
"x-f5xc-required-for": {
|
|
4017
4024
|
"minimum_config": false,
|
|
4018
4025
|
"create": false,
|
|
@@ -4025,6 +4032,7 @@
|
|
|
4025
4032
|
"description": "Error message about the failures of bulk revoke of credentials.",
|
|
4026
4033
|
"title": "Error message.",
|
|
4027
4034
|
"x-displayname": "Error Message.",
|
|
4035
|
+
"x-f5xc-description-short": "Error message about the failures of bulk revoke of credentials.",
|
|
4028
4036
|
"minLength": 0,
|
|
4029
4037
|
"maxLength": 1024,
|
|
4030
4038
|
"x-f5xc-required-for": {
|
|
@@ -4035,6 +4043,7 @@
|
|
|
4035
4043
|
}
|
|
4036
4044
|
}
|
|
4037
4045
|
},
|
|
4046
|
+
"x-f5xc-description-short": "Response format for revoking multiple API credentials.",
|
|
4038
4047
|
"x-f5xc-minimum-configuration": {
|
|
4039
4048
|
"description": "Minimum configuration for api_credentialBulkRevokeResponse",
|
|
4040
4049
|
"required_fields": [
|
|
@@ -4065,6 +4074,7 @@
|
|
|
4065
4074
|
"x-displayname": "Expiry in days.",
|
|
4066
4075
|
"x-ves-example": "Value",
|
|
4067
4076
|
"x-f5xc-example": "value",
|
|
4077
|
+
"x-f5xc-description-short": "Qty of days of service credential expiration.",
|
|
4068
4078
|
"minimum": 0,
|
|
4069
4079
|
"maximum": 2147483647,
|
|
4070
4080
|
"x-f5xc-required-for": {
|
|
@@ -4081,6 +4091,7 @@
|
|
|
4081
4091
|
"x-displayname": "Name",
|
|
4082
4092
|
"x-ves-example": "Value",
|
|
4083
4093
|
"x-f5xc-example": "value",
|
|
4094
|
+
"x-f5xc-description-short": "Name of API credential record. It will be saved in metadata.",
|
|
4084
4095
|
"minLength": 0,
|
|
4085
4096
|
"maxLength": 16,
|
|
4086
4097
|
"x-f5xc-required-for": {
|
|
@@ -4091,7 +4102,7 @@
|
|
|
4091
4102
|
},
|
|
4092
4103
|
"x-original-maxLength": 1024,
|
|
4093
4104
|
"x-reconciled-from-discovery": true,
|
|
4094
|
-
"x-reconciled-at": "2026-01-
|
|
4105
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954169+00:00"
|
|
4095
4106
|
},
|
|
4096
4107
|
"namespace": {
|
|
4097
4108
|
"type": "string",
|
|
@@ -4110,12 +4121,13 @@
|
|
|
4110
4121
|
},
|
|
4111
4122
|
"x-original-maxLength": 1024,
|
|
4112
4123
|
"x-reconciled-from-discovery": true,
|
|
4113
|
-
"x-reconciled-at": "2026-01-
|
|
4124
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954182+00:00"
|
|
4114
4125
|
},
|
|
4115
4126
|
"spec": {
|
|
4116
4127
|
"$ref": "#/components/schemas/api_credentialCustomCreateSpecType"
|
|
4117
4128
|
}
|
|
4118
4129
|
},
|
|
4130
|
+
"x-f5xc-description-short": "CreateRequest is the request format for generating API credential.",
|
|
4119
4131
|
"x-f5xc-minimum-configuration": {
|
|
4120
4132
|
"description": "Minimum configuration for api_credentialCreateRequest",
|
|
4121
4133
|
"required_fields": [
|
|
@@ -4142,6 +4154,8 @@
|
|
|
4142
4154
|
"active": {
|
|
4143
4155
|
"type": "boolean",
|
|
4144
4156
|
"format": "boolean",
|
|
4157
|
+
"description": "Indicates if the resource is active",
|
|
4158
|
+
"x-f5xc-example": "True",
|
|
4145
4159
|
"x-f5xc-required-for": {
|
|
4146
4160
|
"minimum_config": false,
|
|
4147
4161
|
"create": false,
|
|
@@ -4156,6 +4170,8 @@
|
|
|
4156
4170
|
"x-displayname": "Credentials.",
|
|
4157
4171
|
"x-ves-example": "Value",
|
|
4158
4172
|
"x-f5xc-example": "value",
|
|
4173
|
+
"x-f5xc-description-short": "Data is the response format based on the API credential type.",
|
|
4174
|
+
"x-f5xc-description-medium": "Data is the response format based on the API credential type. In case of API_CERTIFICATES, the response is the base64 encoded value of certificate in PKCS12 format. In case of KUBE_CONFIG, the response is the base64 encoded value of the K8s kubeconfig file with contents as requested ...",
|
|
4159
4175
|
"minLength": 0,
|
|
4160
4176
|
"maxLength": 1024,
|
|
4161
4177
|
"x-f5xc-required-for": {
|
|
@@ -4168,6 +4184,8 @@
|
|
|
4168
4184
|
"expiration_timestamp": {
|
|
4169
4185
|
"type": "string",
|
|
4170
4186
|
"format": "date-time",
|
|
4187
|
+
"description": "Configuration parameter for expiration timestamp",
|
|
4188
|
+
"x-f5xc-description-short": "Configuration parameter for expiration timestamp.",
|
|
4171
4189
|
"minLength": 0,
|
|
4172
4190
|
"maxLength": 1024,
|
|
4173
4191
|
"x-f5xc-required-for": {
|
|
@@ -4191,9 +4209,10 @@
|
|
|
4191
4209
|
},
|
|
4192
4210
|
"x-original-maxLength": 1024,
|
|
4193
4211
|
"x-reconciled-from-discovery": true,
|
|
4194
|
-
"x-reconciled-at": "2026-01-
|
|
4212
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954202+00:00"
|
|
4195
4213
|
}
|
|
4196
4214
|
},
|
|
4215
|
+
"x-f5xc-description-short": "CreateResponse is the response format for the credential's create request.",
|
|
4197
4216
|
"x-f5xc-minimum-configuration": {
|
|
4198
4217
|
"description": "Minimum configuration for api_credentialCreateResponse",
|
|
4199
4218
|
"required_fields": [
|
|
@@ -4231,6 +4250,7 @@
|
|
|
4231
4250
|
"x-displayname": "Expiry in days.",
|
|
4232
4251
|
"x-ves-example": "Value",
|
|
4233
4252
|
"x-f5xc-example": "value",
|
|
4253
|
+
"x-f5xc-description-short": "Qty of days of service credential expiration.",
|
|
4234
4254
|
"minimum": 0,
|
|
4235
4255
|
"maximum": 2147483647,
|
|
4236
4256
|
"x-f5xc-required-for": {
|
|
@@ -4247,6 +4267,7 @@
|
|
|
4247
4267
|
"x-displayname": "Name",
|
|
4248
4268
|
"x-ves-example": "Svc-cred-app1.",
|
|
4249
4269
|
"x-f5xc-example": "svc-cred-app1",
|
|
4270
|
+
"x-f5xc-description-short": "Name of API credential record. It will be saved in metadata.",
|
|
4250
4271
|
"minLength": 0,
|
|
4251
4272
|
"maxLength": 16,
|
|
4252
4273
|
"x-f5xc-required-for": {
|
|
@@ -4257,7 +4278,7 @@
|
|
|
4257
4278
|
},
|
|
4258
4279
|
"x-original-maxLength": 1024,
|
|
4259
4280
|
"x-reconciled-from-discovery": true,
|
|
4260
|
-
"x-reconciled-at": "2026-01-
|
|
4281
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954219+00:00"
|
|
4261
4282
|
},
|
|
4262
4283
|
"namespace": {
|
|
4263
4284
|
"type": "string",
|
|
@@ -4276,7 +4297,7 @@
|
|
|
4276
4297
|
},
|
|
4277
4298
|
"x-original-maxLength": 1024,
|
|
4278
4299
|
"x-reconciled-from-discovery": true,
|
|
4279
|
-
"x-reconciled-at": "2026-01-
|
|
4300
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954228+00:00"
|
|
4280
4301
|
},
|
|
4281
4302
|
"namespace_roles": {
|
|
4282
4303
|
"type": "array",
|
|
@@ -4288,6 +4309,7 @@
|
|
|
4288
4309
|
"x-displayname": "List of roles.",
|
|
4289
4310
|
"x-ves-example": "Value",
|
|
4290
4311
|
"x-f5xc-example": "value",
|
|
4312
|
+
"x-f5xc-description-short": "List of roles per namespace to be assigned to service credentials.",
|
|
4291
4313
|
"x-f5xc-required-for": {
|
|
4292
4314
|
"minimum_config": false,
|
|
4293
4315
|
"create": false,
|
|
@@ -4309,6 +4331,8 @@
|
|
|
4309
4331
|
"x-validation-rules": {
|
|
4310
4332
|
"ves.io.schema.rules.message.required": "true"
|
|
4311
4333
|
},
|
|
4334
|
+
"x-f5xc-description-short": "Password is used for generating an API certificate P12 bundle user can use to protect access to it.",
|
|
4335
|
+
"x-f5xc-description-medium": "Password is used for generating an API certificate P12 bundle user can use to protect access to it. This password will not be saved/persisted anywhere in the system. Applicable for credential type API_CERTIFICATE Users have to use this password when they use the certificate, e.g.",
|
|
4312
4336
|
"minLength": 0,
|
|
4313
4337
|
"maxLength": 1024,
|
|
4314
4338
|
"x-f5xc-required-for": {
|
|
@@ -4334,6 +4358,7 @@
|
|
|
4334
4358
|
"x-displayname": "Groups",
|
|
4335
4359
|
"x-ves-example": "[\"dev-group-1\"]",
|
|
4336
4360
|
"x-f5xc-example": "\"[\"dev-group-1\"]\"",
|
|
4361
|
+
"x-f5xc-description-short": "List of user_groups assigned to this service credential.",
|
|
4337
4362
|
"x-f5xc-required-for": {
|
|
4338
4363
|
"minimum_config": false,
|
|
4339
4364
|
"create": false,
|
|
@@ -4348,6 +4373,7 @@
|
|
|
4348
4373
|
"x-displayname": "VK8s Cluster.",
|
|
4349
4374
|
"x-ves-example": "Vk8s-product-app1.",
|
|
4350
4375
|
"x-f5xc-example": "vk8s-product-app1",
|
|
4376
|
+
"x-f5xc-description-short": "Name of virtual_k8s cluster. Applicable for KUBE_CONFIG.",
|
|
4351
4377
|
"minLength": 0,
|
|
4352
4378
|
"maxLength": 1024,
|
|
4353
4379
|
"x-f5xc-required-for": {
|
|
@@ -4364,6 +4390,7 @@
|
|
|
4364
4390
|
"x-displayname": "VK8s Namespace.",
|
|
4365
4391
|
"x-ves-example": "App-ns1",
|
|
4366
4392
|
"x-f5xc-example": "app-ns1",
|
|
4393
|
+
"x-f5xc-description-short": "Namespace of virtual_k8s cluster. Applicable for KUBE_CONFIG.",
|
|
4367
4394
|
"minLength": 0,
|
|
4368
4395
|
"maxLength": 1024,
|
|
4369
4396
|
"x-f5xc-required-for": {
|
|
@@ -4377,6 +4404,7 @@
|
|
|
4377
4404
|
"$ref": "#/components/schemas/api_credentialVk8sKubeconfigType"
|
|
4378
4405
|
}
|
|
4379
4406
|
},
|
|
4407
|
+
"x-f5xc-description-short": "CreateServiceCredentialsRequest is the request format for creating service credentials.",
|
|
4380
4408
|
"x-f5xc-minimum-configuration": {
|
|
4381
4409
|
"description": "Minimum configuration for api_credentialCreateServiceCredentialsRequest",
|
|
4382
4410
|
"required_fields": [
|
|
@@ -4423,6 +4451,8 @@
|
|
|
4423
4451
|
"x-validation-rules": {
|
|
4424
4452
|
"ves.io.schema.rules.message.required": "true"
|
|
4425
4453
|
},
|
|
4454
|
+
"x-f5xc-description-short": "Password is used for generating an API certificate P12 bundle user can use to protect access to it.",
|
|
4455
|
+
"x-f5xc-description-medium": "Password is used for generating an API certificate P12 bundle user can use to protect access to it. This password will not be saved/persisted anywhere in the system. Applicable for credential type API_CERTIFICATE Users have to use this password when they use the certificate, e.g.",
|
|
4426
4456
|
"minLength": 0,
|
|
4427
4457
|
"maxLength": 1024,
|
|
4428
4458
|
"x-f5xc-required-for": {
|
|
@@ -4442,6 +4472,7 @@
|
|
|
4442
4472
|
"x-displayname": "VK8s Cluster.",
|
|
4443
4473
|
"x-ves-example": "Vk8s-product-app1.",
|
|
4444
4474
|
"x-f5xc-example": "vk8s-product-app1",
|
|
4475
|
+
"x-f5xc-description-short": "Name of virtual K8s cluster. Applicable for KUBE_CONFIG.",
|
|
4445
4476
|
"minLength": 0,
|
|
4446
4477
|
"maxLength": 1024,
|
|
4447
4478
|
"x-f5xc-required-for": {
|
|
@@ -4458,6 +4489,7 @@
|
|
|
4458
4489
|
"x-displayname": "VK8s Namespace.",
|
|
4459
4490
|
"x-ves-example": "App-ns1",
|
|
4460
4491
|
"x-f5xc-example": "app-ns1",
|
|
4492
|
+
"x-f5xc-description-short": "Namespace of virtual K8s cluster. Applicable for KUBE_CONFIG.",
|
|
4461
4493
|
"minLength": 0,
|
|
4462
4494
|
"maxLength": 1024,
|
|
4463
4495
|
"x-f5xc-required-for": {
|
|
@@ -4498,6 +4530,7 @@
|
|
|
4498
4530
|
"$ref": "#/components/schemas/api_credentialAPICredentialType"
|
|
4499
4531
|
}
|
|
4500
4532
|
},
|
|
4533
|
+
"x-f5xc-description-short": "It specifies which expired credentials needs to be deleted.",
|
|
4501
4534
|
"x-f5xc-minimum-configuration": {
|
|
4502
4535
|
"description": "Minimum configuration for api_credentialExpiredSelector",
|
|
4503
4536
|
"required_fields": [
|
|
@@ -4542,7 +4575,7 @@
|
|
|
4542
4575
|
},
|
|
4543
4576
|
"x-original-maxLength": 1024,
|
|
4544
4577
|
"x-reconciled-from-discovery": true,
|
|
4545
|
-
"x-reconciled-at": "2026-01-
|
|
4578
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954273+00:00"
|
|
4546
4579
|
},
|
|
4547
4580
|
"namespace": {
|
|
4548
4581
|
"type": "string",
|
|
@@ -4558,6 +4591,7 @@
|
|
|
4558
4591
|
"x-validation-rules": {
|
|
4559
4592
|
"ves.io.schema.rules.message.required": "true"
|
|
4560
4593
|
},
|
|
4594
|
+
"x-f5xc-description-short": "Value of namespace is always \"system\". Required: YES.",
|
|
4561
4595
|
"minLength": 0,
|
|
4562
4596
|
"maxLength": 6,
|
|
4563
4597
|
"x-f5xc-required-for": {
|
|
@@ -4568,9 +4602,10 @@
|
|
|
4568
4602
|
},
|
|
4569
4603
|
"x-original-maxLength": 1024,
|
|
4570
4604
|
"x-reconciled-from-discovery": true,
|
|
4571
|
-
"x-reconciled-at": "2026-01-
|
|
4605
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954284+00:00"
|
|
4572
4606
|
}
|
|
4573
4607
|
},
|
|
4608
|
+
"x-f5xc-description-short": "GET credential object with a given name.",
|
|
4574
4609
|
"x-f5xc-minimum-configuration": {
|
|
4575
4610
|
"description": "Minimum configuration for api_credentialGetRequest",
|
|
4576
4611
|
"required_fields": [
|
|
@@ -4595,6 +4630,7 @@
|
|
|
4595
4630
|
"$ref": "#/components/schemas/api_credentialObject"
|
|
4596
4631
|
}
|
|
4597
4632
|
},
|
|
4633
|
+
"x-f5xc-description-short": "Response of GET credential request with a given name.",
|
|
4598
4634
|
"x-f5xc-minimum-configuration": {
|
|
4599
4635
|
"description": "Minimum configuration for api_credentialGetResponse",
|
|
4600
4636
|
"required_fields": [
|
|
@@ -4622,6 +4658,7 @@
|
|
|
4622
4658
|
"x-displayname": "Active",
|
|
4623
4659
|
"x-ves-example": "True",
|
|
4624
4660
|
"x-f5xc-example": "true",
|
|
4661
|
+
"x-f5xc-description-short": "Possibility to deactivate credential with no deletion.",
|
|
4625
4662
|
"x-f5xc-required-for": {
|
|
4626
4663
|
"minimum_config": false,
|
|
4627
4664
|
"create": false,
|
|
@@ -4676,7 +4713,7 @@
|
|
|
4676
4713
|
},
|
|
4677
4714
|
"x-original-maxLength": 1024,
|
|
4678
4715
|
"x-reconciled-from-discovery": true,
|
|
4679
|
-
"x-reconciled-at": "2026-01-
|
|
4716
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954302+00:00"
|
|
4680
4717
|
},
|
|
4681
4718
|
"namespace": {
|
|
4682
4719
|
"type": "string",
|
|
@@ -4695,7 +4732,7 @@
|
|
|
4695
4732
|
},
|
|
4696
4733
|
"x-original-maxLength": 1024,
|
|
4697
4734
|
"x-reconciled-from-discovery": true,
|
|
4698
|
-
"x-reconciled-at": "2026-01-
|
|
4735
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954311+00:00"
|
|
4699
4736
|
},
|
|
4700
4737
|
"namespace_access": {
|
|
4701
4738
|
"$ref": "#/components/schemas/schemaNamespaceAccessType"
|
|
@@ -4722,7 +4759,7 @@
|
|
|
4722
4759
|
"x-original-maxLength": 1024,
|
|
4723
4760
|
"format": "uuid",
|
|
4724
4761
|
"x-reconciled-from-discovery": true,
|
|
4725
|
-
"x-reconciled-at": "2026-01-
|
|
4762
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954326+00:00"
|
|
4726
4763
|
},
|
|
4727
4764
|
"user_email": {
|
|
4728
4765
|
"type": "string",
|
|
@@ -4731,6 +4768,7 @@
|
|
|
4731
4768
|
"x-displayname": "User",
|
|
4732
4769
|
"x-ves-example": "Admin@example-corp.com.",
|
|
4733
4770
|
"x-f5xc-example": "admin@example-corp.com",
|
|
4771
|
+
"x-f5xc-description-short": "Email of the service user attached to service credential .",
|
|
4734
4772
|
"minLength": 0,
|
|
4735
4773
|
"maxLength": 1024,
|
|
4736
4774
|
"x-f5xc-required-for": {
|
|
@@ -4750,6 +4788,7 @@
|
|
|
4750
4788
|
"x-displayname": "User Groups.",
|
|
4751
4789
|
"x-ves-example": "[\"dev-group-1\"]",
|
|
4752
4790
|
"x-f5xc-example": "\"[\"dev-group-1\"]\"",
|
|
4791
|
+
"x-f5xc-description-short": "User group list associated to this service credential.",
|
|
4753
4792
|
"x-f5xc-required-for": {
|
|
4754
4793
|
"minimum_config": false,
|
|
4755
4794
|
"create": false,
|
|
@@ -4758,6 +4797,7 @@
|
|
|
4758
4797
|
}
|
|
4759
4798
|
}
|
|
4760
4799
|
},
|
|
4800
|
+
"x-f5xc-description-short": "Response of GET service credentials request with a given name.",
|
|
4761
4801
|
"x-f5xc-minimum-configuration": {
|
|
4762
4802
|
"description": "Minimum configuration for api_credentialGetServiceCredentialsResponse",
|
|
4763
4803
|
"required_fields": [
|
|
@@ -4792,6 +4832,8 @@
|
|
|
4792
4832
|
"title": "Active",
|
|
4793
4833
|
"format": "boolean",
|
|
4794
4834
|
"x-displayname": "Active",
|
|
4835
|
+
"x-f5xc-example": "True",
|
|
4836
|
+
"x-f5xc-description-short": "Possibility to deactivate/activate credential with no deletion.",
|
|
4795
4837
|
"x-f5xc-required-for": {
|
|
4796
4838
|
"minimum_config": false,
|
|
4797
4839
|
"create": false,
|
|
@@ -4811,6 +4853,7 @@
|
|
|
4811
4853
|
"x-validation-rules": {
|
|
4812
4854
|
"ves.io.schema.rules.string.max_len": "32"
|
|
4813
4855
|
},
|
|
4856
|
+
"x-f5xc-description-short": "Serial number of the client certificate part of credential type API Certificate or Kubeconfig.",
|
|
4814
4857
|
"minLength": 0,
|
|
4815
4858
|
"x-f5xc-required-for": {
|
|
4816
4859
|
"minimum_config": false,
|
|
@@ -4868,6 +4911,8 @@
|
|
|
4868
4911
|
"description": "Site name when global kubeconfig is issued for physical K8s site.",
|
|
4869
4912
|
"title": "Site Name",
|
|
4870
4913
|
"x-displayname": "Site Name",
|
|
4914
|
+
"x-f5xc-example": "example-resource",
|
|
4915
|
+
"x-f5xc-description-short": "Site name when global kubeconfig is issued for physical K8s site.",
|
|
4871
4916
|
"minLength": 0,
|
|
4872
4917
|
"maxLength": 1024,
|
|
4873
4918
|
"x-f5xc-required-for": {
|
|
@@ -4895,6 +4940,7 @@
|
|
|
4895
4940
|
"x-validation-rules": {
|
|
4896
4941
|
"ves.io.schema.rules.repeated.max_items": "1"
|
|
4897
4942
|
},
|
|
4943
|
+
"x-f5xc-description-short": "Reference to user for whom API credential is created.",
|
|
4898
4944
|
"x-f5xc-required-for": {
|
|
4899
4945
|
"minimum_config": false,
|
|
4900
4946
|
"create": false,
|
|
@@ -4907,6 +4953,7 @@
|
|
|
4907
4953
|
"description": "Name of virtual K8s cluster.",
|
|
4908
4954
|
"title": "Virtual K8s.",
|
|
4909
4955
|
"x-displayname": "Virtual K8s.",
|
|
4956
|
+
"x-f5xc-example": "example-resource",
|
|
4910
4957
|
"minLength": 0,
|
|
4911
4958
|
"maxLength": 1024,
|
|
4912
4959
|
"x-f5xc-required-for": {
|
|
@@ -4921,6 +4968,7 @@
|
|
|
4921
4968
|
"description": "Namespace of virtual_k8s.",
|
|
4922
4969
|
"title": "Virtual K8s namespace.",
|
|
4923
4970
|
"x-displayname": "Namespace",
|
|
4971
|
+
"x-f5xc-example": "example-resource",
|
|
4924
4972
|
"minLength": 0,
|
|
4925
4973
|
"maxLength": 1024,
|
|
4926
4974
|
"x-f5xc-required-for": {
|
|
@@ -4931,6 +4979,7 @@
|
|
|
4931
4979
|
}
|
|
4932
4980
|
}
|
|
4933
4981
|
},
|
|
4982
|
+
"x-f5xc-description-short": "Keeps track of user requested API credentials.",
|
|
4934
4983
|
"x-f5xc-minimum-configuration": {
|
|
4935
4984
|
"description": "Minimum configuration for api_credentialGlobalSpecType",
|
|
4936
4985
|
"required_fields": [
|
|
@@ -4967,6 +5016,7 @@
|
|
|
4967
5016
|
"$ref": "#/components/schemas/api_credentialListResponseItem"
|
|
4968
5017
|
},
|
|
4969
5018
|
"x-displayname": "Credentials.",
|
|
5019
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
4970
5020
|
"x-f5xc-required-for": {
|
|
4971
5021
|
"minimum_config": false,
|
|
4972
5022
|
"create": false,
|
|
@@ -4975,6 +5025,7 @@
|
|
|
4975
5025
|
}
|
|
4976
5026
|
}
|
|
4977
5027
|
},
|
|
5028
|
+
"x-f5xc-description-short": "Response of request to list all of users credential objects.",
|
|
4978
5029
|
"x-f5xc-minimum-configuration": {
|
|
4979
5030
|
"description": "Minimum configuration for api_credentialListResponse",
|
|
4980
5031
|
"required_fields": [
|
|
@@ -5002,6 +5053,7 @@
|
|
|
5002
5053
|
"x-displayname": "Active",
|
|
5003
5054
|
"x-ves-example": "True",
|
|
5004
5055
|
"x-f5xc-example": "true",
|
|
5056
|
+
"x-f5xc-description-short": "Possibility to deactivate credential with no deletion.",
|
|
5005
5057
|
"x-f5xc-required-for": {
|
|
5006
5058
|
"minimum_config": false,
|
|
5007
5059
|
"create": false,
|
|
@@ -5056,7 +5108,7 @@
|
|
|
5056
5108
|
},
|
|
5057
5109
|
"x-original-maxLength": 1024,
|
|
5058
5110
|
"x-reconciled-from-discovery": true,
|
|
5059
|
-
"x-reconciled-at": "2026-01-
|
|
5111
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954376+00:00"
|
|
5060
5112
|
},
|
|
5061
5113
|
"namespace": {
|
|
5062
5114
|
"type": "string",
|
|
@@ -5075,7 +5127,7 @@
|
|
|
5075
5127
|
},
|
|
5076
5128
|
"x-original-maxLength": 1024,
|
|
5077
5129
|
"x-reconciled-from-discovery": true,
|
|
5078
|
-
"x-reconciled-at": "2026-01-
|
|
5130
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954385+00:00"
|
|
5079
5131
|
},
|
|
5080
5132
|
"type": {
|
|
5081
5133
|
"$ref": "#/components/schemas/api_credentialAPICredentialType"
|
|
@@ -5099,7 +5151,7 @@
|
|
|
5099
5151
|
"x-original-maxLength": 1024,
|
|
5100
5152
|
"format": "uuid",
|
|
5101
5153
|
"x-reconciled-from-discovery": true,
|
|
5102
|
-
"x-reconciled-at": "2026-01-
|
|
5154
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954397+00:00"
|
|
5103
5155
|
},
|
|
5104
5156
|
"user_email": {
|
|
5105
5157
|
"type": "string",
|
|
@@ -5108,6 +5160,7 @@
|
|
|
5108
5160
|
"x-displayname": "User",
|
|
5109
5161
|
"x-ves-example": "Admin@example-corp.com.",
|
|
5110
5162
|
"x-f5xc-example": "admin@example-corp.com",
|
|
5163
|
+
"x-f5xc-description-short": "User email of user that requested credential .",
|
|
5111
5164
|
"minLength": 0,
|
|
5112
5165
|
"maxLength": 1024,
|
|
5113
5166
|
"x-f5xc-required-for": {
|
|
@@ -5152,6 +5205,7 @@
|
|
|
5152
5205
|
"$ref": "#/components/schemas/api_credentialListServiceCredentialsResponseItem"
|
|
5153
5206
|
},
|
|
5154
5207
|
"x-displayname": "Service Credentials.",
|
|
5208
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
5155
5209
|
"x-f5xc-required-for": {
|
|
5156
5210
|
"minimum_config": false,
|
|
5157
5211
|
"create": false,
|
|
@@ -5160,6 +5214,7 @@
|
|
|
5160
5214
|
}
|
|
5161
5215
|
}
|
|
5162
5216
|
},
|
|
5217
|
+
"x-f5xc-description-short": "Response of request to list all of service credential objects.",
|
|
5163
5218
|
"x-f5xc-minimum-configuration": {
|
|
5164
5219
|
"description": "Minimum configuration for api_credentialListServiceCredentialsResponse",
|
|
5165
5220
|
"required_fields": [
|
|
@@ -5187,6 +5242,7 @@
|
|
|
5187
5242
|
"x-displayname": "Active",
|
|
5188
5243
|
"x-ves-example": "True",
|
|
5189
5244
|
"x-f5xc-example": "true",
|
|
5245
|
+
"x-f5xc-description-short": "Possibility to deactivate credential with no deletion.",
|
|
5190
5246
|
"x-f5xc-required-for": {
|
|
5191
5247
|
"minimum_config": false,
|
|
5192
5248
|
"create": false,
|
|
@@ -5241,7 +5297,7 @@
|
|
|
5241
5297
|
},
|
|
5242
5298
|
"x-original-maxLength": 1024,
|
|
5243
5299
|
"x-reconciled-from-discovery": true,
|
|
5244
|
-
"x-reconciled-at": "2026-01-
|
|
5300
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954419+00:00"
|
|
5245
5301
|
},
|
|
5246
5302
|
"namespace": {
|
|
5247
5303
|
"type": "string",
|
|
@@ -5260,7 +5316,7 @@
|
|
|
5260
5316
|
},
|
|
5261
5317
|
"x-original-maxLength": 1024,
|
|
5262
5318
|
"x-reconciled-from-discovery": true,
|
|
5263
|
-
"x-reconciled-at": "2026-01-
|
|
5319
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954427+00:00"
|
|
5264
5320
|
},
|
|
5265
5321
|
"namespace_access": {
|
|
5266
5322
|
"$ref": "#/components/schemas/schemaNamespaceAccessType"
|
|
@@ -5287,7 +5343,7 @@
|
|
|
5287
5343
|
"x-original-maxLength": 1024,
|
|
5288
5344
|
"format": "uuid",
|
|
5289
5345
|
"x-reconciled-from-discovery": true,
|
|
5290
|
-
"x-reconciled-at": "2026-01-
|
|
5346
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954440+00:00"
|
|
5291
5347
|
},
|
|
5292
5348
|
"user_email": {
|
|
5293
5349
|
"type": "string",
|
|
@@ -5296,6 +5352,7 @@
|
|
|
5296
5352
|
"x-displayname": "User",
|
|
5297
5353
|
"x-ves-example": "Admin@example-corp.com.",
|
|
5298
5354
|
"x-f5xc-example": "admin@example-corp.com",
|
|
5355
|
+
"x-f5xc-description-short": "User email of user that requested credential .",
|
|
5299
5356
|
"minLength": 0,
|
|
5300
5357
|
"maxLength": 1024,
|
|
5301
5358
|
"x-f5xc-required-for": {
|
|
@@ -5315,6 +5372,7 @@
|
|
|
5315
5372
|
"x-displayname": "User Groups.",
|
|
5316
5373
|
"x-ves-example": "[\"dev-group-1\"]",
|
|
5317
5374
|
"x-f5xc-example": "\"[\"dev-group-1\"]\"",
|
|
5375
|
+
"x-f5xc-description-short": "User group list associated to this service credential.",
|
|
5318
5376
|
"x-f5xc-required-for": {
|
|
5319
5377
|
"minimum_config": false,
|
|
5320
5378
|
"create": false,
|
|
@@ -5323,6 +5381,7 @@
|
|
|
5323
5381
|
}
|
|
5324
5382
|
}
|
|
5325
5383
|
},
|
|
5384
|
+
"x-f5xc-description-short": "Each item of service credential list request.",
|
|
5326
5385
|
"x-f5xc-minimum-configuration": {
|
|
5327
5386
|
"description": "Minimum configuration for api_credentialListServiceCredentialsResponseItem",
|
|
5328
5387
|
"required_fields": [
|
|
@@ -5374,6 +5433,8 @@
|
|
|
5374
5433
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
5375
5434
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
5376
5435
|
},
|
|
5436
|
+
"x-f5xc-example": "example-resource",
|
|
5437
|
+
"x-f5xc-description-short": "It contains the names of credentials which needs to be deleted. Required: YES.",
|
|
5377
5438
|
"x-f5xc-required-for": {
|
|
5378
5439
|
"minimum_config": false,
|
|
5379
5440
|
"create": false,
|
|
@@ -5411,6 +5472,7 @@
|
|
|
5411
5472
|
"$ref": "#/components/schemas/schemaSystemObjectMetaType"
|
|
5412
5473
|
}
|
|
5413
5474
|
},
|
|
5475
|
+
"x-f5xc-description-short": "API Credential object represents the user request to create a certificate.",
|
|
5414
5476
|
"x-f5xc-minimum-configuration": {
|
|
5415
5477
|
"description": "Minimum configuration for api_credentialObject",
|
|
5416
5478
|
"required_fields": [
|
|
@@ -5448,6 +5510,8 @@
|
|
|
5448
5510
|
"ves.io.schema.rules.uint32.gte": "1",
|
|
5449
5511
|
"ves.io.schema.rules.uint32.lte": "730"
|
|
5450
5512
|
},
|
|
5513
|
+
"x-f5xc-description-short": "Qty of days of service credential expiration. Default value is 180.",
|
|
5514
|
+
"x-f5xc-description-medium": "Qty of days of service credential expiration. Default value is 180. Expiration days value can range between 1 and 730.",
|
|
5451
5515
|
"minimum": 0,
|
|
5452
5516
|
"maximum": 2147483647,
|
|
5453
5517
|
"x-f5xc-required-for": {
|
|
@@ -5474,9 +5538,10 @@
|
|
|
5474
5538
|
},
|
|
5475
5539
|
"x-original-maxLength": 1024,
|
|
5476
5540
|
"x-reconciled-from-discovery": true,
|
|
5477
|
-
"x-reconciled-at": "2026-01-
|
|
5541
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954466+00:00"
|
|
5478
5542
|
}
|
|
5479
5543
|
},
|
|
5544
|
+
"x-f5xc-description-short": "RecreateScimTokenRequest is the request format for generating SCIM API credential.",
|
|
5480
5545
|
"x-f5xc-minimum-configuration": {
|
|
5481
5546
|
"description": "Minimum configuration for api_credentialRecreateScimTokenRequest",
|
|
5482
5547
|
"required_fields": [
|
|
@@ -5505,6 +5570,7 @@
|
|
|
5505
5570
|
"x-displayname": "Expiry in days.",
|
|
5506
5571
|
"x-ves-example": "Value",
|
|
5507
5572
|
"x-f5xc-example": "value",
|
|
5573
|
+
"x-f5xc-description-short": "Qty of days of service credential expiration.",
|
|
5508
5574
|
"minimum": 0,
|
|
5509
5575
|
"maximum": 2147483647,
|
|
5510
5576
|
"x-f5xc-required-for": {
|
|
@@ -5528,6 +5594,7 @@
|
|
|
5528
5594
|
"x-validation-rules": {
|
|
5529
5595
|
"ves.io.schema.rules.message.required": "true"
|
|
5530
5596
|
},
|
|
5597
|
+
"x-f5xc-description-short": "Name of API credential object. Required: YES.",
|
|
5531
5598
|
"minLength": 0,
|
|
5532
5599
|
"maxLength": 16,
|
|
5533
5600
|
"x-f5xc-required-for": {
|
|
@@ -5538,7 +5605,7 @@
|
|
|
5538
5605
|
},
|
|
5539
5606
|
"x-original-maxLength": 1024,
|
|
5540
5607
|
"x-reconciled-from-discovery": true,
|
|
5541
|
-
"x-reconciled-at": "2026-01-
|
|
5608
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954479+00:00"
|
|
5542
5609
|
},
|
|
5543
5610
|
"namespace": {
|
|
5544
5611
|
"type": "string",
|
|
@@ -5554,6 +5621,7 @@
|
|
|
5554
5621
|
"x-validation-rules": {
|
|
5555
5622
|
"ves.io.schema.rules.message.required": "true"
|
|
5556
5623
|
},
|
|
5624
|
+
"x-f5xc-description-short": "Value of namespace is always \"system\" . Required: YES.",
|
|
5557
5625
|
"minLength": 0,
|
|
5558
5626
|
"maxLength": 6,
|
|
5559
5627
|
"x-f5xc-required-for": {
|
|
@@ -5564,7 +5632,7 @@
|
|
|
5564
5632
|
},
|
|
5565
5633
|
"x-original-maxLength": 1024,
|
|
5566
5634
|
"x-reconciled-from-discovery": true,
|
|
5567
|
-
"x-reconciled-at": "2026-01-
|
|
5635
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954484+00:00"
|
|
5568
5636
|
}
|
|
5569
5637
|
},
|
|
5570
5638
|
"x-f5xc-minimum-configuration": {
|
|
@@ -5602,6 +5670,7 @@
|
|
|
5602
5670
|
"x-validation-rules": {
|
|
5603
5671
|
"ves.io.schema.rules.message.required": "true"
|
|
5604
5672
|
},
|
|
5673
|
+
"x-f5xc-description-short": "Name of service credential object. Required: YES.",
|
|
5605
5674
|
"minLength": 0,
|
|
5606
5675
|
"maxLength": 16,
|
|
5607
5676
|
"x-f5xc-required-for": {
|
|
@@ -5612,7 +5681,7 @@
|
|
|
5612
5681
|
},
|
|
5613
5682
|
"x-original-maxLength": 1024,
|
|
5614
5683
|
"x-reconciled-from-discovery": true,
|
|
5615
|
-
"x-reconciled-at": "2026-01-
|
|
5684
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954489+00:00"
|
|
5616
5685
|
},
|
|
5617
5686
|
"namespace": {
|
|
5618
5687
|
"type": "string",
|
|
@@ -5621,6 +5690,7 @@
|
|
|
5621
5690
|
"x-displayname": "Namespace",
|
|
5622
5691
|
"x-ves-example": "System",
|
|
5623
5692
|
"x-f5xc-example": "system",
|
|
5693
|
+
"x-f5xc-description-short": "Namespace of the service credential user. Value of namespace is always \"system\".",
|
|
5624
5694
|
"minLength": 0,
|
|
5625
5695
|
"maxLength": 6,
|
|
5626
5696
|
"x-f5xc-required-for": {
|
|
@@ -5631,7 +5701,7 @@
|
|
|
5631
5701
|
},
|
|
5632
5702
|
"x-original-maxLength": 1024,
|
|
5633
5703
|
"x-reconciled-from-discovery": true,
|
|
5634
|
-
"x-reconciled-at": "2026-01-
|
|
5704
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954493+00:00"
|
|
5635
5705
|
},
|
|
5636
5706
|
"namespace_access": {
|
|
5637
5707
|
"$ref": "#/components/schemas/schemaNamespaceAccessType"
|
|
@@ -5646,6 +5716,7 @@
|
|
|
5646
5716
|
"x-displayname": "Groups",
|
|
5647
5717
|
"x-ves-example": "[\"dev-group-1\"]",
|
|
5648
5718
|
"x-f5xc-example": "\"[\"dev-group-1\"]\"",
|
|
5719
|
+
"x-f5xc-description-short": "List of user_groups to be replaced for this service credentials.",
|
|
5649
5720
|
"x-f5xc-required-for": {
|
|
5650
5721
|
"minimum_config": false,
|
|
5651
5722
|
"create": false,
|
|
@@ -5654,6 +5725,7 @@
|
|
|
5654
5725
|
}
|
|
5655
5726
|
}
|
|
5656
5727
|
},
|
|
5728
|
+
"x-f5xc-description-short": "Request format for replacing service credentials.",
|
|
5657
5729
|
"x-f5xc-minimum-configuration": {
|
|
5658
5730
|
"description": "Minimum configuration for api_credentialReplaceServiceCredentialsRequest",
|
|
5659
5731
|
"required_fields": [
|
|
@@ -5684,6 +5756,7 @@
|
|
|
5684
5756
|
"x-displayname": "Active",
|
|
5685
5757
|
"x-ves-example": "True",
|
|
5686
5758
|
"x-f5xc-example": "true",
|
|
5759
|
+
"x-f5xc-description-short": "Specifies if service credential is active or not.",
|
|
5687
5760
|
"x-f5xc-required-for": {
|
|
5688
5761
|
"minimum_config": false,
|
|
5689
5762
|
"create": false,
|
|
@@ -5723,9 +5796,10 @@
|
|
|
5723
5796
|
},
|
|
5724
5797
|
"x-original-maxLength": 1024,
|
|
5725
5798
|
"x-reconciled-from-discovery": true,
|
|
5726
|
-
"x-reconciled-at": "2026-01-
|
|
5799
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954518+00:00"
|
|
5727
5800
|
}
|
|
5728
5801
|
},
|
|
5802
|
+
"x-f5xc-description-short": "Response format for the credential's replace request.",
|
|
5729
5803
|
"x-f5xc-minimum-configuration": {
|
|
5730
5804
|
"description": "Minimum configuration for api_credentialReplaceServiceCredentialsResponse",
|
|
5731
5805
|
"required_fields": [
|
|
@@ -5761,6 +5835,7 @@
|
|
|
5761
5835
|
"x-validation-rules": {
|
|
5762
5836
|
"ves.io.schema.rules.message.required": "true"
|
|
5763
5837
|
},
|
|
5838
|
+
"x-f5xc-description-short": "Value of namespace is always \"system\". Required: YES.",
|
|
5764
5839
|
"minLength": 0,
|
|
5765
5840
|
"maxLength": 6,
|
|
5766
5841
|
"x-f5xc-required-for": {
|
|
@@ -5771,9 +5846,10 @@
|
|
|
5771
5846
|
},
|
|
5772
5847
|
"x-original-maxLength": 1024,
|
|
5773
5848
|
"x-reconciled-from-discovery": true,
|
|
5774
|
-
"x-reconciled-at": "2026-01-
|
|
5849
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954524+00:00"
|
|
5775
5850
|
}
|
|
5776
5851
|
},
|
|
5852
|
+
"x-f5xc-description-short": "ScimTokenRequest is used for fetching or revoking scim token.",
|
|
5777
5853
|
"x-f5xc-minimum-configuration": {
|
|
5778
5854
|
"description": "Minimum configuration for api_credentialScimTokenRequest",
|
|
5779
5855
|
"required_fields": [
|
|
@@ -5813,6 +5889,7 @@
|
|
|
5813
5889
|
"ves.io.schema.rules.string.max_bytes": "64",
|
|
5814
5890
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
5815
5891
|
},
|
|
5892
|
+
"x-f5xc-description-short": "Name of the site for which kubeconfig is being requested. Required: YES.",
|
|
5816
5893
|
"x-f5xc-required-for": {
|
|
5817
5894
|
"minimum_config": false,
|
|
5818
5895
|
"create": false,
|
|
@@ -5844,6 +5921,7 @@
|
|
|
5844
5921
|
"$ref": "#/components/schemas/api_credentialGlobalSpecType"
|
|
5845
5922
|
}
|
|
5846
5923
|
},
|
|
5924
|
+
"x-f5xc-description-short": "Shape of the API credential specification.",
|
|
5847
5925
|
"x-f5xc-minimum-configuration": {
|
|
5848
5926
|
"description": "Minimum configuration for api_credentialSpecType",
|
|
5849
5927
|
"required_fields": [
|
|
@@ -5880,7 +5958,7 @@
|
|
|
5880
5958
|
"maxLength": 17,
|
|
5881
5959
|
"minLength": 17,
|
|
5882
5960
|
"x-reconciled-from-discovery": true,
|
|
5883
|
-
"x-reconciled-at": "2026-01-
|
|
5961
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954534+00:00"
|
|
5884
5962
|
}
|
|
5885
5963
|
},
|
|
5886
5964
|
"x-f5xc-minimum-configuration": {
|
|
@@ -5937,6 +6015,7 @@
|
|
|
5937
6015
|
"x-validation-rules": {
|
|
5938
6016
|
"ves.io.schema.rules.string.ves_object_name": "true"
|
|
5939
6017
|
},
|
|
6018
|
+
"x-f5xc-description-short": "Namespace of virtual K8s cluster. Applicable for KUBE_CONFIG.",
|
|
5940
6019
|
"minLength": 0,
|
|
5941
6020
|
"maxLength": 1024,
|
|
5942
6021
|
"x-f5xc-required-for": {
|
|
@@ -5966,6 +6045,7 @@
|
|
|
5966
6045
|
"title": "Empty",
|
|
5967
6046
|
"x-displayname": "Empty",
|
|
5968
6047
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
6048
|
+
"x-f5xc-description-short": "Can be used for messages where no values are needed.",
|
|
5969
6049
|
"x-f5xc-minimum-configuration": {
|
|
5970
6050
|
"description": "Minimum configuration for schemaEmpty",
|
|
5971
6051
|
"required_fields": [],
|
|
@@ -5989,6 +6069,7 @@
|
|
|
5989
6069
|
"title": "Name",
|
|
5990
6070
|
"x-displayname": "Name",
|
|
5991
6071
|
"x-f5xc-example": "example-resource",
|
|
6072
|
+
"x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
|
|
5992
6073
|
"minLength": 0,
|
|
5993
6074
|
"maxLength": 16,
|
|
5994
6075
|
"x-f5xc-required-for": {
|
|
@@ -5999,9 +6080,10 @@
|
|
|
5999
6080
|
},
|
|
6000
6081
|
"x-original-maxLength": 1024,
|
|
6001
6082
|
"x-reconciled-from-discovery": true,
|
|
6002
|
-
"x-reconciled-at": "2026-01-
|
|
6083
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954544+00:00"
|
|
6003
6084
|
}
|
|
6004
6085
|
},
|
|
6086
|
+
"x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
|
|
6005
6087
|
"x-f5xc-minimum-configuration": {
|
|
6006
6088
|
"description": "Minimum configuration for schemaInitializerType",
|
|
6007
6089
|
"required_fields": [
|
|
@@ -6029,6 +6111,8 @@
|
|
|
6029
6111
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
6030
6112
|
},
|
|
6031
6113
|
"x-displayname": "Pending",
|
|
6114
|
+
"x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
|
|
6115
|
+
"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.",
|
|
6032
6116
|
"x-f5xc-required-for": {
|
|
6033
6117
|
"minimum_config": false,
|
|
6034
6118
|
"create": false,
|
|
@@ -6040,6 +6124,7 @@
|
|
|
6040
6124
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
6041
6125
|
}
|
|
6042
6126
|
},
|
|
6127
|
+
"x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
|
|
6043
6128
|
"x-f5xc-minimum-configuration": {
|
|
6044
6129
|
"description": "Minimum configuration for schemaInitializersType",
|
|
6045
6130
|
"required_fields": [
|
|
@@ -6075,6 +6160,7 @@
|
|
|
6075
6160
|
"ves.io.schema.rules.map.keys.string.max_len": "256",
|
|
6076
6161
|
"ves.io.schema.rules.message.required": "true"
|
|
6077
6162
|
},
|
|
6163
|
+
"x-f5xc-description-short": "List of all the roles for the entity in the namespaces Required: YES.",
|
|
6078
6164
|
"x-f5xc-required-for": {
|
|
6079
6165
|
"minimum_config": false,
|
|
6080
6166
|
"create": false,
|
|
@@ -6083,6 +6169,7 @@
|
|
|
6083
6169
|
}
|
|
6084
6170
|
}
|
|
6085
6171
|
},
|
|
6172
|
+
"x-f5xc-description-short": "Access info in the namespaces for the entity.",
|
|
6086
6173
|
"x-f5xc-minimum-configuration": {
|
|
6087
6174
|
"description": "Minimum configuration for schemaNamespaceAccessType",
|
|
6088
6175
|
"required_fields": [
|
|
@@ -6119,6 +6206,7 @@
|
|
|
6119
6206
|
"ves.io.schema.rules.message.required": "true",
|
|
6120
6207
|
"ves.io.schema.rules.string.max_len": "256"
|
|
6121
6208
|
},
|
|
6209
|
+
"x-f5xc-description-short": "Namespace the role applies to '*' value implies all namespaces Required: YES.",
|
|
6122
6210
|
"minLength": 0,
|
|
6123
6211
|
"x-f5xc-required-for": {
|
|
6124
6212
|
"minimum_config": false,
|
|
@@ -6128,7 +6216,7 @@
|
|
|
6128
6216
|
},
|
|
6129
6217
|
"x-original-maxLength": 256,
|
|
6130
6218
|
"x-reconciled-from-discovery": true,
|
|
6131
|
-
"x-reconciled-at": "2026-01-
|
|
6219
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954555+00:00"
|
|
6132
6220
|
},
|
|
6133
6221
|
"role": {
|
|
6134
6222
|
"type": "string",
|
|
@@ -6149,6 +6237,7 @@
|
|
|
6149
6237
|
"ves.io.schema.rules.string.max_len": "256",
|
|
6150
6238
|
"ves.io.schema.rules.string.ves_object_name": "true"
|
|
6151
6239
|
},
|
|
6240
|
+
"x-f5xc-description-short": "Users role for this namespace Required: YES.",
|
|
6152
6241
|
"minLength": 0,
|
|
6153
6242
|
"x-f5xc-required-for": {
|
|
6154
6243
|
"minimum_config": false,
|
|
@@ -6197,6 +6286,8 @@
|
|
|
6197
6286
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
6198
6287
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
6199
6288
|
},
|
|
6289
|
+
"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.",
|
|
6290
|
+
"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.",
|
|
6200
6291
|
"x-f5xc-required-for": {
|
|
6201
6292
|
"minimum_config": false,
|
|
6202
6293
|
"create": false,
|
|
@@ -6218,6 +6309,7 @@
|
|
|
6218
6309
|
"x-validation-rules": {
|
|
6219
6310
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
6220
6311
|
},
|
|
6312
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
6221
6313
|
"minLength": 0,
|
|
6222
6314
|
"x-f5xc-required-for": {
|
|
6223
6315
|
"minimum_config": false,
|
|
@@ -6227,7 +6319,7 @@
|
|
|
6227
6319
|
},
|
|
6228
6320
|
"x-original-maxLength": 1200,
|
|
6229
6321
|
"x-reconciled-from-discovery": true,
|
|
6230
|
-
"x-reconciled-at": "2026-01-
|
|
6322
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954564+00:00"
|
|
6231
6323
|
},
|
|
6232
6324
|
"disable": {
|
|
6233
6325
|
"type": "boolean",
|
|
@@ -6237,6 +6329,7 @@
|
|
|
6237
6329
|
"x-displayname": "Disable",
|
|
6238
6330
|
"x-ves-example": "True",
|
|
6239
6331
|
"x-f5xc-example": "true",
|
|
6332
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
6240
6333
|
"x-f5xc-required-for": {
|
|
6241
6334
|
"minimum_config": false,
|
|
6242
6335
|
"create": false,
|
|
@@ -6251,6 +6344,8 @@
|
|
|
6251
6344
|
"x-displayname": "Labels",
|
|
6252
6345
|
"x-ves-example": "Value",
|
|
6253
6346
|
"x-f5xc-example": "value",
|
|
6347
|
+
"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.",
|
|
6348
|
+
"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.",
|
|
6254
6349
|
"x-f5xc-required-for": {
|
|
6255
6350
|
"minimum_config": false,
|
|
6256
6351
|
"create": false,
|
|
@@ -6272,6 +6367,8 @@
|
|
|
6272
6367
|
"x-validation-rules": {
|
|
6273
6368
|
"ves.io.schema.rules.message.required": "true"
|
|
6274
6369
|
},
|
|
6370
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
6371
|
+
"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.",
|
|
6275
6372
|
"minLength": 0,
|
|
6276
6373
|
"maxLength": 16,
|
|
6277
6374
|
"x-f5xc-required-for": {
|
|
@@ -6282,7 +6379,7 @@
|
|
|
6282
6379
|
},
|
|
6283
6380
|
"x-original-maxLength": 1024,
|
|
6284
6381
|
"x-reconciled-from-discovery": true,
|
|
6285
|
-
"x-reconciled-at": "2026-01-
|
|
6382
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954572+00:00"
|
|
6286
6383
|
},
|
|
6287
6384
|
"namespace": {
|
|
6288
6385
|
"type": "string",
|
|
@@ -6291,6 +6388,8 @@
|
|
|
6291
6388
|
"x-displayname": "Namespace",
|
|
6292
6389
|
"x-ves-example": "Staging",
|
|
6293
6390
|
"x-f5xc-example": "staging",
|
|
6391
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
6392
|
+
"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 \"\".",
|
|
6294
6393
|
"minLength": 0,
|
|
6295
6394
|
"maxLength": 6,
|
|
6296
6395
|
"x-f5xc-required-for": {
|
|
@@ -6301,7 +6400,7 @@
|
|
|
6301
6400
|
},
|
|
6302
6401
|
"x-original-maxLength": 1024,
|
|
6303
6402
|
"x-reconciled-from-discovery": true,
|
|
6304
|
-
"x-reconciled-at": "2026-01-
|
|
6403
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954577+00:00"
|
|
6305
6404
|
},
|
|
6306
6405
|
"uid": {
|
|
6307
6406
|
"type": "string",
|
|
@@ -6310,6 +6409,8 @@
|
|
|
6310
6409
|
"x-displayname": "UID",
|
|
6311
6410
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
6312
6411
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
6412
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object. Object create will fail if provided by the client and the value exists in the system.",
|
|
6413
|
+
"x-f5xc-description-medium": "Uid is the unique in time and space value for this object. Object create will fail if provided by the client and the value exists in the system. Typically generated by the server on successful creation of an object and is not allowed to change once populated.",
|
|
6313
6414
|
"minLength": 0,
|
|
6314
6415
|
"maxLength": 36,
|
|
6315
6416
|
"x-f5xc-required-for": {
|
|
@@ -6323,9 +6424,11 @@
|
|
|
6323
6424
|
"x-original-maxLength": 1024,
|
|
6324
6425
|
"format": "uuid",
|
|
6325
6426
|
"x-reconciled-from-discovery": true,
|
|
6326
|
-
"x-reconciled-at": "2026-01-
|
|
6427
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954582+00:00"
|
|
6327
6428
|
}
|
|
6328
6429
|
},
|
|
6430
|
+
"x-f5xc-description-short": "ObjectMetaType is metadata(common attributes) of an object that all configuration objects will have.",
|
|
6431
|
+
"x-f5xc-description-medium": "ObjectMetaType is metadata(common attributes) of an object that all configuration objects will have. The information in this type can be specified by user during create and replace APIs.",
|
|
6329
6432
|
"x-f5xc-minimum-configuration": {
|
|
6330
6433
|
"description": "Minimum configuration for schemaObjectMetaType",
|
|
6331
6434
|
"required_fields": [
|
|
@@ -6358,6 +6461,8 @@
|
|
|
6358
6461
|
"x-displayname": "Kind",
|
|
6359
6462
|
"x-ves-example": "Virtual_site.",
|
|
6360
6463
|
"x-f5xc-example": "virtual_site",
|
|
6464
|
+
"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\")",
|
|
6465
|
+
"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\").",
|
|
6361
6466
|
"minLength": 0,
|
|
6362
6467
|
"maxLength": 14,
|
|
6363
6468
|
"x-f5xc-required-for": {
|
|
@@ -6369,7 +6474,7 @@
|
|
|
6369
6474
|
"readOnly": true,
|
|
6370
6475
|
"x-original-maxLength": 1024,
|
|
6371
6476
|
"x-reconciled-from-discovery": true,
|
|
6372
|
-
"x-reconciled-at": "2026-01-
|
|
6477
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954587+00:00"
|
|
6373
6478
|
},
|
|
6374
6479
|
"name": {
|
|
6375
6480
|
"type": "string",
|
|
@@ -6378,6 +6483,8 @@
|
|
|
6378
6483
|
"x-displayname": "Name",
|
|
6379
6484
|
"x-ves-example": "Contactus-route.",
|
|
6380
6485
|
"x-f5xc-example": "contactus-route",
|
|
6486
|
+
"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.",
|
|
6487
|
+
"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.",
|
|
6381
6488
|
"minLength": 0,
|
|
6382
6489
|
"maxLength": 16,
|
|
6383
6490
|
"x-f5xc-required-for": {
|
|
@@ -6388,7 +6495,7 @@
|
|
|
6388
6495
|
},
|
|
6389
6496
|
"x-original-maxLength": 1024,
|
|
6390
6497
|
"x-reconciled-from-discovery": true,
|
|
6391
|
-
"x-reconciled-at": "2026-01-
|
|
6498
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954591+00:00"
|
|
6392
6499
|
},
|
|
6393
6500
|
"namespace": {
|
|
6394
6501
|
"type": "string",
|
|
@@ -6397,6 +6504,8 @@
|
|
|
6397
6504
|
"x-displayname": "Namespace",
|
|
6398
6505
|
"x-ves-example": "Ns1",
|
|
6399
6506
|
"x-f5xc-example": "ns1",
|
|
6507
|
+
"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.",
|
|
6508
|
+
"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.",
|
|
6400
6509
|
"minLength": 0,
|
|
6401
6510
|
"maxLength": 6,
|
|
6402
6511
|
"x-f5xc-required-for": {
|
|
@@ -6407,7 +6516,7 @@
|
|
|
6407
6516
|
},
|
|
6408
6517
|
"x-original-maxLength": 1024,
|
|
6409
6518
|
"x-reconciled-from-discovery": true,
|
|
6410
|
-
"x-reconciled-at": "2026-01-
|
|
6519
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954595+00:00"
|
|
6411
6520
|
},
|
|
6412
6521
|
"tenant": {
|
|
6413
6522
|
"type": "string",
|
|
@@ -6416,6 +6525,8 @@
|
|
|
6416
6525
|
"x-displayname": "Tenant",
|
|
6417
6526
|
"x-ves-example": "Example-corp.",
|
|
6418
6527
|
"x-f5xc-example": "example-corp",
|
|
6528
|
+
"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.",
|
|
6529
|
+
"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.",
|
|
6419
6530
|
"minLength": 0,
|
|
6420
6531
|
"maxLength": 18,
|
|
6421
6532
|
"x-f5xc-required-for": {
|
|
@@ -6428,7 +6539,7 @@
|
|
|
6428
6539
|
"x-field-mutability": "read-only",
|
|
6429
6540
|
"x-original-maxLength": 1024,
|
|
6430
6541
|
"x-reconciled-from-discovery": true,
|
|
6431
|
-
"x-reconciled-at": "2026-01-
|
|
6542
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954599+00:00"
|
|
6432
6543
|
},
|
|
6433
6544
|
"uid": {
|
|
6434
6545
|
"type": "string",
|
|
@@ -6437,6 +6548,8 @@
|
|
|
6437
6548
|
"x-displayname": "UID",
|
|
6438
6549
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
6439
6550
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
6551
|
+
"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.",
|
|
6552
|
+
"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.",
|
|
6440
6553
|
"minLength": 0,
|
|
6441
6554
|
"maxLength": 36,
|
|
6442
6555
|
"x-f5xc-required-for": {
|
|
@@ -6450,9 +6563,11 @@
|
|
|
6450
6563
|
"x-original-maxLength": 1024,
|
|
6451
6564
|
"format": "uuid",
|
|
6452
6565
|
"x-reconciled-from-discovery": true,
|
|
6453
|
-
"x-reconciled-at": "2026-01-
|
|
6566
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954604+00:00"
|
|
6454
6567
|
}
|
|
6455
6568
|
},
|
|
6569
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
6570
|
+
"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...",
|
|
6456
6571
|
"x-f5xc-minimum-configuration": {
|
|
6457
6572
|
"description": "Minimum configuration for schemaObjectRefType",
|
|
6458
6573
|
"required_fields": [
|
|
@@ -6481,6 +6596,7 @@
|
|
|
6481
6596
|
"items": {
|
|
6482
6597
|
"type": "string"
|
|
6483
6598
|
},
|
|
6599
|
+
"x-f5xc-example": "example-resource",
|
|
6484
6600
|
"x-f5xc-required-for": {
|
|
6485
6601
|
"minimum_config": false,
|
|
6486
6602
|
"create": false,
|
|
@@ -6516,6 +6632,7 @@
|
|
|
6516
6632
|
"x-displayname": "Code",
|
|
6517
6633
|
"x-ves-example": "0",
|
|
6518
6634
|
"x-f5xc-example": "0",
|
|
6635
|
+
"x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
|
|
6519
6636
|
"minimum": 0,
|
|
6520
6637
|
"maximum": 2147483647,
|
|
6521
6638
|
"x-f5xc-required-for": {
|
|
@@ -6532,6 +6649,8 @@
|
|
|
6532
6649
|
"x-displayname": "Reason",
|
|
6533
6650
|
"x-ves-example": "Value",
|
|
6534
6651
|
"x-f5xc-example": "value",
|
|
6652
|
+
"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.",
|
|
6653
|
+
"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.",
|
|
6535
6654
|
"minLength": 0,
|
|
6536
6655
|
"maxLength": 43,
|
|
6537
6656
|
"x-f5xc-required-for": {
|
|
@@ -6542,7 +6661,7 @@
|
|
|
6542
6661
|
},
|
|
6543
6662
|
"x-original-maxLength": 1024,
|
|
6544
6663
|
"x-reconciled-from-discovery": true,
|
|
6545
|
-
"x-reconciled-at": "2026-01-
|
|
6664
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954613+00:00"
|
|
6546
6665
|
},
|
|
6547
6666
|
"status": {
|
|
6548
6667
|
"type": "string",
|
|
@@ -6551,6 +6670,7 @@
|
|
|
6551
6670
|
"x-displayname": "Status",
|
|
6552
6671
|
"x-ves-example": "Value",
|
|
6553
6672
|
"x-f5xc-example": "value",
|
|
6673
|
+
"x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
|
|
6554
6674
|
"minLength": 0,
|
|
6555
6675
|
"maxLength": 17,
|
|
6556
6676
|
"x-f5xc-required-for": {
|
|
@@ -6561,9 +6681,10 @@
|
|
|
6561
6681
|
},
|
|
6562
6682
|
"x-original-maxLength": 1024,
|
|
6563
6683
|
"x-reconciled-from-discovery": true,
|
|
6564
|
-
"x-reconciled-at": "2026-01-
|
|
6684
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954617+00:00"
|
|
6565
6685
|
}
|
|
6566
6686
|
},
|
|
6687
|
+
"x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
|
|
6567
6688
|
"x-f5xc-minimum-configuration": {
|
|
6568
6689
|
"description": "Minimum configuration for schemaStatusType",
|
|
6569
6690
|
"required_fields": [
|
|
@@ -6591,6 +6712,8 @@
|
|
|
6591
6712
|
"title": "Creation_timestamp.",
|
|
6592
6713
|
"format": "date-time",
|
|
6593
6714
|
"x-displayname": "Creation Timestamp.",
|
|
6715
|
+
"x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
|
|
6716
|
+
"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.",
|
|
6594
6717
|
"minLength": 0,
|
|
6595
6718
|
"maxLength": 1024,
|
|
6596
6719
|
"x-f5xc-required-for": {
|
|
@@ -6609,6 +6732,7 @@
|
|
|
6609
6732
|
"x-displayname": "Creator Class.",
|
|
6610
6733
|
"x-ves-example": "Value",
|
|
6611
6734
|
"x-f5xc-example": "value",
|
|
6735
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
6612
6736
|
"minLength": 0,
|
|
6613
6737
|
"maxLength": 1024,
|
|
6614
6738
|
"x-f5xc-required-for": {
|
|
@@ -6627,6 +6751,8 @@
|
|
|
6627
6751
|
"x-displayname": "Creator Cookie.",
|
|
6628
6752
|
"x-ves-example": "Value",
|
|
6629
6753
|
"x-f5xc-example": "value",
|
|
6754
|
+
"x-f5xc-description-short": "Can used by the creator of the object for later audit for e.g.",
|
|
6755
|
+
"x-f5xc-description-medium": "Can used by the creator of the object for later audit for e.g. By storing the version identifying information of the object so at future it can be determined if version present at remote end is current or stale.",
|
|
6630
6756
|
"minLength": 0,
|
|
6631
6757
|
"maxLength": 1024,
|
|
6632
6758
|
"x-f5xc-required-for": {
|
|
@@ -6644,6 +6770,7 @@
|
|
|
6644
6770
|
"x-displayname": "Creator ID.",
|
|
6645
6771
|
"x-ves-example": "Value",
|
|
6646
6772
|
"x-f5xc-example": "value",
|
|
6773
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
6647
6774
|
"minLength": 0,
|
|
6648
6775
|
"maxLength": 1024,
|
|
6649
6776
|
"x-f5xc-required-for": {
|
|
@@ -6661,6 +6788,8 @@
|
|
|
6661
6788
|
"title": "Deletion_timestamp.",
|
|
6662
6789
|
"format": "date-time",
|
|
6663
6790
|
"x-displayname": "Deletion Timestamp.",
|
|
6791
|
+
"x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
|
|
6792
|
+
"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...",
|
|
6664
6793
|
"minLength": 0,
|
|
6665
6794
|
"maxLength": 1024,
|
|
6666
6795
|
"x-f5xc-required-for": {
|
|
@@ -6675,6 +6804,8 @@
|
|
|
6675
6804
|
"description": "A hash of the UIDs of direct references on this object. This can be used to determine if\nthis object hash has had references become resolved/unresolved.",
|
|
6676
6805
|
"title": "Direct_ref_hash.",
|
|
6677
6806
|
"x-displayname": "Direct Reference Hash.",
|
|
6807
|
+
"x-f5xc-description-short": "Hash of the UIDs of direct references on this object. This can be used to determine if this object hash has had references become resolved/unresolved.",
|
|
6808
|
+
"x-f5xc-description-medium": "Hash of the UIDs of direct references on this object. This can be used to determine if this object hash has had references become resolved/unresolved.",
|
|
6678
6809
|
"minLength": 0,
|
|
6679
6810
|
"maxLength": 1024,
|
|
6680
6811
|
"x-f5xc-required-for": {
|
|
@@ -6694,6 +6825,8 @@
|
|
|
6694
6825
|
"x-displayname": "Finalizers.",
|
|
6695
6826
|
"x-ves-example": "Value",
|
|
6696
6827
|
"x-f5xc-example": "value",
|
|
6828
|
+
"x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
|
|
6829
|
+
"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.",
|
|
6697
6830
|
"x-f5xc-required-for": {
|
|
6698
6831
|
"minimum_config": false,
|
|
6699
6832
|
"create": false,
|
|
@@ -6711,6 +6844,8 @@
|
|
|
6711
6844
|
"x-displayname": "Labels",
|
|
6712
6845
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
6713
6846
|
"x-f5xc-example": "'F5 XC/soft-deleted''true'",
|
|
6847
|
+
"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.",
|
|
6848
|
+
"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).",
|
|
6714
6849
|
"x-f5xc-required-for": {
|
|
6715
6850
|
"minimum_config": false,
|
|
6716
6851
|
"create": false,
|
|
@@ -6724,6 +6859,8 @@
|
|
|
6724
6859
|
"title": "Modification_timestamp.",
|
|
6725
6860
|
"format": "date-time",
|
|
6726
6861
|
"x-displayname": "Modification Timestamp.",
|
|
6862
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
6863
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
6727
6864
|
"minLength": 0,
|
|
6728
6865
|
"maxLength": 1024,
|
|
6729
6866
|
"x-f5xc-required-for": {
|
|
@@ -6750,6 +6887,9 @@
|
|
|
6750
6887
|
"x-validation-rules": {
|
|
6751
6888
|
"ves.io.schema.rules.repeated.max_items": "1"
|
|
6752
6889
|
},
|
|
6890
|
+
"x-f5xc-example": "example-resource",
|
|
6891
|
+
"x-f5xc-description-short": "The namespace this object belongs to. This is populated by the service based on the metadata.namespace field when an object is created.",
|
|
6892
|
+
"x-f5xc-description-medium": "The namespace this object belongs to. This is populated by the service based on the metadata.namespace field when an object is created.",
|
|
6753
6893
|
"x-f5xc-required-for": {
|
|
6754
6894
|
"minimum_config": false,
|
|
6755
6895
|
"create": false,
|
|
@@ -6759,7 +6899,7 @@
|
|
|
6759
6899
|
"maxLength": 6,
|
|
6760
6900
|
"minLength": 6,
|
|
6761
6901
|
"x-reconciled-from-discovery": true,
|
|
6762
|
-
"x-reconciled-at": "2026-01-
|
|
6902
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954638+00:00"
|
|
6763
6903
|
},
|
|
6764
6904
|
"object_index": {
|
|
6765
6905
|
"type": "integer",
|
|
@@ -6769,6 +6909,8 @@
|
|
|
6769
6909
|
"x-displayname": "Object Index.",
|
|
6770
6910
|
"x-ves-example": "0",
|
|
6771
6911
|
"x-f5xc-example": "0",
|
|
6912
|
+
"x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
|
|
6913
|
+
"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.",
|
|
6772
6914
|
"minimum": 0,
|
|
6773
6915
|
"maximum": 2147483647,
|
|
6774
6916
|
"x-f5xc-required-for": {
|
|
@@ -6789,6 +6931,8 @@
|
|
|
6789
6931
|
"title": "Revision",
|
|
6790
6932
|
"format": "int64",
|
|
6791
6933
|
"x-displayname": "Revision",
|
|
6934
|
+
"x-f5xc-description-short": "Revision number which always increases with each modification of the object in storage This doesn't necessarily increase sequentially, but should...",
|
|
6935
|
+
"x-f5xc-description-medium": "Revision number which always increases with each modification of the object in storage This doesn't necessarily increase sequentially, but should always increase. This will be 0 when first created, and before any modifications.",
|
|
6792
6936
|
"minLength": 0,
|
|
6793
6937
|
"maxLength": 1024,
|
|
6794
6938
|
"x-f5xc-required-for": {
|
|
@@ -6806,6 +6950,8 @@
|
|
|
6806
6950
|
"x-displayname": "SRE Disable.",
|
|
6807
6951
|
"x-ves-example": "True",
|
|
6808
6952
|
"x-f5xc-example": "true",
|
|
6953
|
+
"x-f5xc-description-short": "Should be set to true If F5XC/SRE operator wants to suppress an object from being presented to business-logic of a daemon(e.g.",
|
|
6954
|
+
"x-f5xc-description-medium": "Should be set to true If F5XC/SRE operator wants to suppress an object from being presented to business-logic of a daemon(e.g. Due to bad-form/issue-causing Object). This is meant only to be used in temporary situations for operational continuity till a fix is rolled out in business-logic.",
|
|
6809
6955
|
"x-f5xc-required-for": {
|
|
6810
6956
|
"minimum_config": false,
|
|
6811
6957
|
"create": false,
|
|
@@ -6820,6 +6966,8 @@
|
|
|
6820
6966
|
"x-displayname": "Tenant",
|
|
6821
6967
|
"x-ves-example": "Example-corp.",
|
|
6822
6968
|
"x-f5xc-example": "example-corp",
|
|
6969
|
+
"x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
6970
|
+
"x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
6823
6971
|
"minLength": 0,
|
|
6824
6972
|
"maxLength": 18,
|
|
6825
6973
|
"x-f5xc-required-for": {
|
|
@@ -6832,7 +6980,7 @@
|
|
|
6832
6980
|
"x-field-mutability": "read-only",
|
|
6833
6981
|
"x-original-maxLength": 1024,
|
|
6834
6982
|
"x-reconciled-from-discovery": true,
|
|
6835
|
-
"x-reconciled-at": "2026-01-
|
|
6983
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954647+00:00"
|
|
6836
6984
|
},
|
|
6837
6985
|
"trace_info": {
|
|
6838
6986
|
"type": "string",
|
|
@@ -6841,6 +6989,8 @@
|
|
|
6841
6989
|
"x-displayname": "Trace Info.",
|
|
6842
6990
|
"x-ves-example": "Value",
|
|
6843
6991
|
"x-f5xc-example": "value",
|
|
6992
|
+
"x-f5xc-description-short": "Trace_info holds information(<trace-ID>:<span-ID>:<parent-span-ID>) of the request doing the object modification.",
|
|
6993
|
+
"x-f5xc-description-medium": "Trace_info holds information(<trace-ID>:<span-ID>:<parent-span-ID>) of the request doing the object modification. This can be used on the watch side to create subsequent spans. This information can be used to co-relate activities across services (modulo state compression) for a synchronous API.",
|
|
6844
6994
|
"minLength": 0,
|
|
6845
6995
|
"maxLength": 1024,
|
|
6846
6996
|
"x-f5xc-required-for": {
|
|
@@ -6857,6 +7007,8 @@
|
|
|
6857
7007
|
"x-displayname": "UID",
|
|
6858
7008
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
6859
7009
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
7010
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
|
|
7011
|
+
"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.",
|
|
6860
7012
|
"minLength": 0,
|
|
6861
7013
|
"maxLength": 36,
|
|
6862
7014
|
"x-f5xc-required-for": {
|
|
@@ -6870,7 +7022,7 @@
|
|
|
6870
7022
|
"x-original-maxLength": 1024,
|
|
6871
7023
|
"format": "uuid",
|
|
6872
7024
|
"x-reconciled-from-discovery": true,
|
|
6873
|
-
"x-reconciled-at": "2026-01-
|
|
7025
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954654+00:00"
|
|
6874
7026
|
},
|
|
6875
7027
|
"vtrp_id": {
|
|
6876
7028
|
"type": "string",
|
|
@@ -6893,6 +7045,7 @@
|
|
|
6893
7045
|
"title": "Vtrp_stale.",
|
|
6894
7046
|
"format": "boolean",
|
|
6895
7047
|
"x-displayname": "VTRP Stale.",
|
|
7048
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
6896
7049
|
"x-f5xc-required-for": {
|
|
6897
7050
|
"minimum_config": false,
|
|
6898
7051
|
"create": false,
|
|
@@ -6901,6 +7054,8 @@
|
|
|
6901
7054
|
}
|
|
6902
7055
|
}
|
|
6903
7056
|
},
|
|
7057
|
+
"x-f5xc-description-short": "SystemObjectMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
7058
|
+
"x-f5xc-description-medium": "SystemObjectMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
6904
7059
|
"x-f5xc-minimum-configuration": {
|
|
6905
7060
|
"description": "Minimum configuration for schemaSystemObjectMetaType",
|
|
6906
7061
|
"required_fields": [
|
|
@@ -6956,7 +7111,7 @@
|
|
|
6956
7111
|
},
|
|
6957
7112
|
"x-original-maxLength": 1024,
|
|
6958
7113
|
"x-reconciled-from-discovery": true,
|
|
6959
|
-
"x-reconciled-at": "2026-01-
|
|
7114
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954662+00:00"
|
|
6960
7115
|
},
|
|
6961
7116
|
"name": {
|
|
6962
7117
|
"type": "string",
|
|
@@ -6965,6 +7120,8 @@
|
|
|
6965
7120
|
"x-displayname": "Name",
|
|
6966
7121
|
"x-ves-example": "Contactus-route.",
|
|
6967
7122
|
"x-f5xc-example": "contactus-route",
|
|
7123
|
+
"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.",
|
|
7124
|
+
"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.",
|
|
6968
7125
|
"minLength": 0,
|
|
6969
7126
|
"maxLength": 16,
|
|
6970
7127
|
"x-f5xc-required-for": {
|
|
@@ -6975,7 +7132,7 @@
|
|
|
6975
7132
|
},
|
|
6976
7133
|
"x-original-maxLength": 1024,
|
|
6977
7134
|
"x-reconciled-from-discovery": true,
|
|
6978
|
-
"x-reconciled-at": "2026-01-
|
|
7135
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954666+00:00"
|
|
6979
7136
|
},
|
|
6980
7137
|
"namespace": {
|
|
6981
7138
|
"type": "string",
|
|
@@ -6984,6 +7141,8 @@
|
|
|
6984
7141
|
"x-displayname": "Namespace",
|
|
6985
7142
|
"x-ves-example": "Ns1",
|
|
6986
7143
|
"x-f5xc-example": "ns1",
|
|
7144
|
+
"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.",
|
|
7145
|
+
"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.",
|
|
6987
7146
|
"minLength": 0,
|
|
6988
7147
|
"maxLength": 6,
|
|
6989
7148
|
"x-f5xc-required-for": {
|
|
@@ -6994,7 +7153,7 @@
|
|
|
6994
7153
|
},
|
|
6995
7154
|
"x-original-maxLength": 1024,
|
|
6996
7155
|
"x-reconciled-from-discovery": true,
|
|
6997
|
-
"x-reconciled-at": "2026-01-
|
|
7156
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954670+00:00"
|
|
6998
7157
|
},
|
|
6999
7158
|
"uid": {
|
|
7000
7159
|
"type": "string",
|
|
@@ -7015,9 +7174,10 @@
|
|
|
7015
7174
|
"x-original-maxLength": 1024,
|
|
7016
7175
|
"format": "uuid",
|
|
7017
7176
|
"x-reconciled-from-discovery": true,
|
|
7018
|
-
"x-reconciled-at": "2026-01-
|
|
7177
|
+
"x-reconciled-at": "2026-01-07T15:27:46.954675+00:00"
|
|
7019
7178
|
}
|
|
7020
7179
|
},
|
|
7180
|
+
"x-f5xc-description-short": "ViewRefType represents a reference to a view.",
|
|
7021
7181
|
"x-f5xc-minimum-configuration": {
|
|
7022
7182
|
"description": "Minimum configuration for schemaViewRefType",
|
|
7023
7183
|
"required_fields": [
|