@robinmordasiewicz/f5xc-api-mcp 1.0.91-2601040555 → 2.0.2-2601050111
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/generator/dependency-extractor.d.ts +0 -4
- package/dist/generator/dependency-extractor.d.ts.map +1 -1
- package/dist/generator/dependency-extractor.js +0 -4
- package/dist/generator/dependency-extractor.js.map +1 -1
- package/dist/generator/domain-metadata.d.ts.map +1 -1
- package/dist/generator/domain-metadata.js +18 -15
- package/dist/generator/domain-metadata.js.map +1 -1
- package/dist/generator/naming/acronyms.d.ts +0 -18
- package/dist/generator/naming/acronyms.d.ts.map +1 -1
- package/dist/generator/naming/acronyms.js +0 -27
- package/dist/generator/naming/acronyms.js.map +1 -1
- package/dist/generator/naming/index.d.ts +5 -2
- package/dist/generator/naming/index.d.ts.map +1 -1
- package/dist/generator/naming/index.js +5 -2
- package/dist/generator/naming/index.js.map +1 -1
- package/dist/generator/naming/volterra-mapping.d.ts +4 -72
- package/dist/generator/naming/volterra-mapping.d.ts.map +1 -1
- package/dist/generator/naming/volterra-mapping.js +4 -189
- package/dist/generator/naming/volterra-mapping.js.map +1 -1
- package/dist/generator/openapi-parser.d.ts +0 -12
- package/dist/generator/openapi-parser.d.ts.map +1 -1
- package/dist/generator/openapi-parser.js +1 -240
- package/dist/generator/openapi-parser.js.map +1 -1
- package/dist/generator/transformers/normalize-examples.d.ts +2 -3
- package/dist/generator/transformers/normalize-examples.d.ts.map +1 -1
- package/dist/generator/transformers/normalize-examples.js +2 -3
- package/dist/generator/transformers/normalize-examples.js.map +1 -1
- package/dist/tools/generated/admin_console_and_ui/index.d.ts.map +1 -1
- package/dist/tools/generated/admin_console_and_ui/index.js +2 -12
- package/dist/tools/generated/admin_console_and_ui/index.js.map +1 -1
- package/dist/tools/generated/ai_services/index.d.ts.map +1 -1
- package/dist/tools/generated/ai_services/index.js +4 -16
- package/dist/tools/generated/ai_services/index.js.map +1 -1
- package/dist/tools/generated/api/index.d.ts.map +1 -1
- package/dist/tools/generated/api/index.js +77 -309
- package/dist/tools/generated/api/index.js.map +1 -1
- package/dist/tools/generated/authentication/index.d.ts.map +1 -1
- package/dist/tools/generated/authentication/index.js +7 -34
- package/dist/tools/generated/authentication/index.js.map +1 -1
- package/dist/tools/generated/bigip/index.d.ts.map +1 -1
- package/dist/tools/generated/bigip/index.js +43 -156
- package/dist/tools/generated/bigip/index.js.map +1 -1
- package/dist/tools/generated/billing_and_usage/index.d.ts.map +1 -1
- package/dist/tools/generated/billing_and_usage/index.js +19 -94
- package/dist/tools/generated/billing_and_usage/index.js.map +1 -1
- package/dist/tools/generated/blindfold/index.d.ts.map +1 -1
- package/dist/tools/generated/blindfold/index.js +30 -162
- package/dist/tools/generated/blindfold/index.js.map +1 -1
- package/dist/tools/generated/bot_and_threat_defense/index.d.ts.map +1 -1
- package/dist/tools/generated/bot_and_threat_defense/index.js +25 -107
- package/dist/tools/generated/bot_and_threat_defense/index.js.map +1 -1
- package/dist/tools/generated/cdn/index.d.ts.map +1 -1
- package/dist/tools/generated/cdn/index.js +30 -116
- package/dist/tools/generated/cdn/index.js.map +1 -1
- package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
- package/dist/tools/generated/ce_management/index.js +37 -162
- package/dist/tools/generated/ce_management/index.js.map +1 -1
- package/dist/tools/generated/certificates/index.d.ts.map +1 -1
- package/dist/tools/generated/certificates/index.js +40 -132
- package/dist/tools/generated/certificates/index.js.map +1 -1
- package/dist/tools/generated/cloud_infrastructure/index.d.ts.map +1 -1
- package/dist/tools/generated/cloud_infrastructure/index.js +47 -170
- package/dist/tools/generated/cloud_infrastructure/index.js.map +1 -1
- package/dist/tools/generated/container_services/index.d.ts.map +1 -1
- package/dist/tools/generated/container_services/index.js +154 -114
- package/dist/tools/generated/container_services/index.js.map +1 -1
- package/dist/tools/generated/data_and_privacy_security/index.d.ts.map +1 -1
- package/dist/tools/generated/data_and_privacy_security/index.js +133 -90
- package/dist/tools/generated/data_and_privacy_security/index.js.map +1 -1
- package/dist/tools/generated/data_intelligence/index.d.ts.map +1 -1
- package/dist/tools/generated/data_intelligence/index.js +11 -56
- package/dist/tools/generated/data_intelligence/index.js.map +1 -1
- package/dist/tools/generated/ddos/index.d.ts.map +1 -1
- package/dist/tools/generated/ddos/index.js +988 -445
- package/dist/tools/generated/ddos/index.js.map +1 -1
- package/dist/tools/generated/dependency-graph.json +2709 -396
- package/dist/tools/generated/dns/index.d.ts.map +1 -1
- package/dist/tools/generated/dns/index.js +45 -229
- package/dist/tools/generated/dns/index.js.map +1 -1
- package/dist/tools/generated/managed_kubernetes/index.d.ts.map +1 -1
- package/dist/tools/generated/managed_kubernetes/index.js +90 -205
- package/dist/tools/generated/managed_kubernetes/index.js.map +1 -1
- package/dist/tools/generated/marketplace/index.d.ts.map +1 -1
- package/dist/tools/generated/marketplace/index.js +46 -203
- package/dist/tools/generated/marketplace/index.js.map +1 -1
- package/dist/tools/generated/network/index.d.ts.map +1 -1
- package/dist/tools/generated/network/index.js +175 -629
- package/dist/tools/generated/network/index.js.map +1 -1
- package/dist/tools/generated/network_security/index.d.ts.map +1 -1
- package/dist/tools/generated/network_security/index.js +114 -427
- package/dist/tools/generated/network_security/index.js.map +1 -1
- package/dist/tools/generated/nginx_one/index.d.ts.map +1 -1
- package/dist/tools/generated/nginx_one/index.js +18 -74
- package/dist/tools/generated/nginx_one/index.js.map +1 -1
- package/dist/tools/generated/object_storage/index.d.ts.map +1 -1
- package/dist/tools/generated/object_storage/index.js +7 -66
- package/dist/tools/generated/object_storage/index.js.map +1 -1
- package/dist/tools/generated/observability/index.d.ts.map +1 -1
- package/dist/tools/generated/observability/index.js +43 -282
- package/dist/tools/generated/observability/index.js.map +1 -1
- package/dist/tools/generated/rate_limiting/index.d.ts.map +1 -1
- package/dist/tools/generated/rate_limiting/index.js +30 -99
- package/dist/tools/generated/rate_limiting/index.js.map +1 -1
- package/dist/tools/generated/secops_and_incident_response/index.d.ts.map +1 -1
- package/dist/tools/generated/secops_and_incident_response/index.js +10 -33
- package/dist/tools/generated/secops_and_incident_response/index.js.map +1 -1
- package/dist/tools/generated/service_mesh/index.d.ts.map +1 -1
- package/dist/tools/generated/service_mesh/index.js +151 -658
- package/dist/tools/generated/service_mesh/index.js.map +1 -1
- package/dist/tools/generated/shape/index.d.ts.map +1 -1
- package/dist/tools/generated/shape/index.js +2668 -961
- package/dist/tools/generated/shape/index.js.map +1 -1
- package/dist/tools/generated/sites/index.d.ts.map +1 -1
- package/dist/tools/generated/sites/index.js +151 -622
- package/dist/tools/generated/sites/index.js.map +1 -1
- package/dist/tools/generated/statistics/index.d.ts.map +1 -1
- package/dist/tools/generated/statistics/index.js +78 -373
- package/dist/tools/generated/statistics/index.js.map +1 -1
- package/dist/tools/generated/support/index.d.ts.map +1 -1
- package/dist/tools/generated/support/index.js +43 -290
- package/dist/tools/generated/support/index.js.map +1 -1
- package/dist/tools/generated/telemetry_and_insights/index.d.ts.map +1 -1
- package/dist/tools/generated/telemetry_and_insights/index.js +16 -90
- package/dist/tools/generated/telemetry_and_insights/index.js.map +1 -1
- package/dist/tools/generated/tenant_and_identity/index.d.ts.map +1 -1
- package/dist/tools/generated/tenant_and_identity/index.js +130 -623
- package/dist/tools/generated/tenant_and_identity/index.js.map +1 -1
- package/dist/tools/generated/threat_campaign/index.d.ts.map +1 -1
- package/dist/tools/generated/threat_campaign/index.js +1 -4
- package/dist/tools/generated/threat_campaign/index.js.map +1 -1
- package/dist/tools/generated/users/index.d.ts.map +1 -1
- package/dist/tools/generated/users/index.js +13 -69
- package/dist/tools/generated/users/index.js.map +1 -1
- package/dist/tools/generated/virtual/index.d.ts.map +1 -1
- package/dist/tools/generated/virtual/index.js +129 -554
- package/dist/tools/generated/virtual/index.js.map +1 -1
- package/dist/tools/generated/waf/index.d.ts.map +1 -1
- package/dist/tools/generated/waf/index.js +42 -178
- package/dist/tools/generated/waf/index.js.map +1 -1
- package/dist/version.d.ts +2 -2
- package/dist/version.d.ts.map +1 -1
- package/dist/version.js +2 -2
- package/dist/version.js.map +1 -1
- package/manifest.json +20 -6
- package/package.json +1 -1
- package/specs/domains/admin_console_and_ui.json +140 -117
- package/specs/domains/ai_services.json +359 -285
- package/specs/domains/api.json +1710 -1808
- package/specs/domains/authentication.json +345 -302
- package/specs/domains/bigip.json +939 -1014
- package/specs/domains/billing_and_usage.json +724 -638
- package/specs/domains/blindfold.json +1027 -1011
- package/specs/domains/bot_and_threat_defense.json +542 -500
- package/specs/domains/cdn.json +3179 -3756
- package/specs/domains/ce_management.json +1607 -1667
- package/specs/domains/certificates.json +569 -560
- package/specs/domains/cloud_infrastructure.json +1295 -1342
- package/specs/domains/container_services.json +931 -1047
- package/specs/domains/data_and_privacy_security.json +489 -505
- package/specs/domains/data_intelligence.json +523 -497
- package/specs/domains/ddos.json +1473 -1334
- package/specs/domains/dns.json +1494 -1680
- package/specs/domains/managed_kubernetes.json +709 -759
- package/specs/domains/marketplace.json +1092 -1105
- package/specs/domains/network.json +2598 -2759
- package/specs/domains/network_security.json +2196 -2335
- package/specs/domains/nginx_one.json +444 -424
- package/specs/domains/object_storage.json +131 -146
- package/specs/domains/observability.json +1681 -1604
- package/specs/domains/rate_limiting.json +440 -438
- package/specs/domains/secops_and_incident_response.json +242 -220
- package/specs/domains/service_mesh.json +1530 -1561
- package/specs/domains/shape.json +5193 -4964
- package/specs/domains/sites.json +6092 -6475
- package/specs/domains/statistics.json +3453 -3314
- package/specs/domains/support.json +1369 -1127
- package/specs/domains/telemetry_and_insights.json +1052 -1021
- package/specs/domains/tenant_and_identity.json +3407 -3091
- package/specs/domains/threat_campaign.json +916 -975
- package/specs/domains/users.json +422 -366
- package/specs/domains/virtual.json +4194 -4982
- package/specs/domains/vpm_and_node_management.json +6 -6
- package/specs/domains/waf.json +1769 -1780
- package/specs/index.json +463 -675
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Authentication",
|
|
5
5
|
"description": "F5 Distributed Cloud Authentication API specifications",
|
|
6
|
-
"version": "
|
|
6
|
+
"version": "2.0.2",
|
|
7
7
|
"contact": {
|
|
8
8
|
"name": "F5 Distributed Cloud",
|
|
9
9
|
"url": "https://docs.cloud.f5.com"
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
"variables": {
|
|
22
22
|
"tenant": {
|
|
23
23
|
"default": "example-corp",
|
|
24
|
-
"description": "F5 Distributed Cloud tenant identifier (e.g.,
|
|
24
|
+
"description": "F5 Distributed Cloud tenant identifier (e.g., example-company, acme-inc)"
|
|
25
25
|
},
|
|
26
26
|
"console_url": {
|
|
27
27
|
"default": "console.ves.volterra.io",
|
|
@@ -566,7 +566,7 @@
|
|
|
566
566
|
"schema": {
|
|
567
567
|
"type": "string"
|
|
568
568
|
},
|
|
569
|
-
"x-
|
|
569
|
+
"x-f5xc-example": "system"
|
|
570
570
|
}
|
|
571
571
|
],
|
|
572
572
|
"requestBody": {
|
|
@@ -773,7 +773,7 @@
|
|
|
773
773
|
"schema": {
|
|
774
774
|
"type": "string"
|
|
775
775
|
},
|
|
776
|
-
"x-
|
|
776
|
+
"x-f5xc-example": "system"
|
|
777
777
|
}
|
|
778
778
|
],
|
|
779
779
|
"requestBody": {
|
|
@@ -980,7 +980,7 @@
|
|
|
980
980
|
"schema": {
|
|
981
981
|
"type": "string"
|
|
982
982
|
},
|
|
983
|
-
"x-
|
|
983
|
+
"x-f5xc-example": "value"
|
|
984
984
|
}
|
|
985
985
|
],
|
|
986
986
|
"externalDocs": {
|
|
@@ -1163,7 +1163,7 @@
|
|
|
1163
1163
|
"schema": {
|
|
1164
1164
|
"type": "string"
|
|
1165
1165
|
},
|
|
1166
|
-
"x-
|
|
1166
|
+
"x-f5xc-example": "value"
|
|
1167
1167
|
}
|
|
1168
1168
|
],
|
|
1169
1169
|
"requestBody": {
|
|
@@ -1377,7 +1377,7 @@
|
|
|
1377
1377
|
"schema": {
|
|
1378
1378
|
"type": "string"
|
|
1379
1379
|
},
|
|
1380
|
-
"x-
|
|
1380
|
+
"x-f5xc-example": "system"
|
|
1381
1381
|
},
|
|
1382
1382
|
{
|
|
1383
1383
|
"name": "name",
|
|
@@ -1388,7 +1388,7 @@
|
|
|
1388
1388
|
"schema": {
|
|
1389
1389
|
"type": "string"
|
|
1390
1390
|
},
|
|
1391
|
-
"x-
|
|
1391
|
+
"x-f5xc-example": "value"
|
|
1392
1392
|
}
|
|
1393
1393
|
],
|
|
1394
1394
|
"externalDocs": {
|
|
@@ -1578,7 +1578,7 @@
|
|
|
1578
1578
|
"schema": {
|
|
1579
1579
|
"type": "string"
|
|
1580
1580
|
},
|
|
1581
|
-
"x-
|
|
1581
|
+
"x-f5xc-example": "system"
|
|
1582
1582
|
}
|
|
1583
1583
|
],
|
|
1584
1584
|
"requestBody": {
|
|
@@ -1785,7 +1785,7 @@
|
|
|
1785
1785
|
"schema": {
|
|
1786
1786
|
"type": "string"
|
|
1787
1787
|
},
|
|
1788
|
-
"x-
|
|
1788
|
+
"x-f5xc-example": "system"
|
|
1789
1789
|
}
|
|
1790
1790
|
],
|
|
1791
1791
|
"requestBody": {
|
|
@@ -1992,7 +1992,7 @@
|
|
|
1992
1992
|
"schema": {
|
|
1993
1993
|
"type": "string"
|
|
1994
1994
|
},
|
|
1995
|
-
"x-
|
|
1995
|
+
"x-f5xc-example": "system"
|
|
1996
1996
|
}
|
|
1997
1997
|
],
|
|
1998
1998
|
"requestBody": {
|
|
@@ -2199,7 +2199,7 @@
|
|
|
2199
2199
|
"schema": {
|
|
2200
2200
|
"type": "string"
|
|
2201
2201
|
},
|
|
2202
|
-
"x-
|
|
2202
|
+
"x-f5xc-example": "system"
|
|
2203
2203
|
}
|
|
2204
2204
|
],
|
|
2205
2205
|
"requestBody": {
|
|
@@ -2413,7 +2413,7 @@
|
|
|
2413
2413
|
"schema": {
|
|
2414
2414
|
"type": "string"
|
|
2415
2415
|
},
|
|
2416
|
-
"x-
|
|
2416
|
+
"x-f5xc-example": "system"
|
|
2417
2417
|
}
|
|
2418
2418
|
],
|
|
2419
2419
|
"requestBody": {
|
|
@@ -2620,7 +2620,7 @@
|
|
|
2620
2620
|
"schema": {
|
|
2621
2621
|
"type": "string"
|
|
2622
2622
|
},
|
|
2623
|
-
"x-
|
|
2623
|
+
"x-f5xc-example": "system"
|
|
2624
2624
|
}
|
|
2625
2625
|
],
|
|
2626
2626
|
"externalDocs": {
|
|
@@ -2803,7 +2803,7 @@
|
|
|
2803
2803
|
"schema": {
|
|
2804
2804
|
"type": "string"
|
|
2805
2805
|
},
|
|
2806
|
-
"x-
|
|
2806
|
+
"x-f5xc-example": "value"
|
|
2807
2807
|
}
|
|
2808
2808
|
],
|
|
2809
2809
|
"requestBody": {
|
|
@@ -3017,7 +3017,7 @@
|
|
|
3017
3017
|
"schema": {
|
|
3018
3018
|
"type": "string"
|
|
3019
3019
|
},
|
|
3020
|
-
"x-
|
|
3020
|
+
"x-f5xc-example": "value"
|
|
3021
3021
|
}
|
|
3022
3022
|
],
|
|
3023
3023
|
"externalDocs": {
|
|
@@ -3200,7 +3200,7 @@
|
|
|
3200
3200
|
"schema": {
|
|
3201
3201
|
"type": "string"
|
|
3202
3202
|
},
|
|
3203
|
-
"x-
|
|
3203
|
+
"x-f5xc-example": "system"
|
|
3204
3204
|
}
|
|
3205
3205
|
],
|
|
3206
3206
|
"requestBody": {
|
|
@@ -3414,7 +3414,7 @@
|
|
|
3414
3414
|
"schema": {
|
|
3415
3415
|
"type": "string"
|
|
3416
3416
|
},
|
|
3417
|
-
"x-
|
|
3417
|
+
"x-f5xc-example": "system"
|
|
3418
3418
|
},
|
|
3419
3419
|
{
|
|
3420
3420
|
"name": "name",
|
|
@@ -3425,7 +3425,7 @@
|
|
|
3425
3425
|
"schema": {
|
|
3426
3426
|
"type": "string"
|
|
3427
3427
|
},
|
|
3428
|
-
"x-
|
|
3428
|
+
"x-f5xc-example": "value"
|
|
3429
3429
|
}
|
|
3430
3430
|
],
|
|
3431
3431
|
"externalDocs": {
|
|
@@ -3610,7 +3610,7 @@
|
|
|
3610
3610
|
"schema": {
|
|
3611
3611
|
"type": "string"
|
|
3612
3612
|
},
|
|
3613
|
-
"x-
|
|
3613
|
+
"x-f5xc-example": "system"
|
|
3614
3614
|
},
|
|
3615
3615
|
{
|
|
3616
3616
|
"name": "name",
|
|
@@ -3621,7 +3621,7 @@
|
|
|
3621
3621
|
"schema": {
|
|
3622
3622
|
"type": "string"
|
|
3623
3623
|
},
|
|
3624
|
-
"x-
|
|
3624
|
+
"x-f5xc-example": "api-cred-73c7cbd9-1342-4ce0-97a5-6c515c0b147a"
|
|
3625
3625
|
}
|
|
3626
3626
|
],
|
|
3627
3627
|
"requestBody": {
|
|
@@ -3746,7 +3746,7 @@
|
|
|
3746
3746
|
"default": "API_CERTIFICATE",
|
|
3747
3747
|
"x-displayname": "Credential Type.",
|
|
3748
3748
|
"x-ves-proto-enum": "ves.io.schema.api_credential.APICredentialType",
|
|
3749
|
-
"x-
|
|
3749
|
+
"x-f5xc-minimum-configuration": {
|
|
3750
3750
|
"description": "Minimum configuration for api_credentialAPICredentialType",
|
|
3751
3751
|
"required_fields": [],
|
|
3752
3752
|
"mutually_exclusive_groups": [],
|
|
@@ -3754,7 +3754,7 @@
|
|
|
3754
3754
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
3755
3755
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_a_p_i_credential_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3756
3756
|
},
|
|
3757
|
-
"x-
|
|
3757
|
+
"x-f5xc-cli-domain": "api"
|
|
3758
3758
|
},
|
|
3759
3759
|
"api_credentialApiCertificateType": {
|
|
3760
3760
|
"type": "object",
|
|
@@ -3777,15 +3777,13 @@
|
|
|
3777
3777
|
"ves.io.schema.rules.string.max_bytes": "50",
|
|
3778
3778
|
"ves.io.schema.rules.string.min_bytes": "6"
|
|
3779
3779
|
},
|
|
3780
|
+
"x-f5xc-example": "myPassw0rd123",
|
|
3780
3781
|
"x-validation-rules": {
|
|
3781
3782
|
"ves.io.schema.rules.message.required": "true",
|
|
3782
3783
|
"ves.io.schema.rules.string.max_bytes": "50",
|
|
3783
3784
|
"ves.io.schema.rules.string.min_bytes": "6"
|
|
3784
3785
|
},
|
|
3785
|
-
"
|
|
3786
|
-
"ves.io.schema.rules.string.max_bytes": "50",
|
|
3787
|
-
"ves.io.schema.rules.string.min_bytes": "6",
|
|
3788
|
-
"x-ves-required-for": {
|
|
3786
|
+
"x-f5xc-required-for": {
|
|
3789
3787
|
"minimum_config": false,
|
|
3790
3788
|
"create": false,
|
|
3791
3789
|
"update": false,
|
|
@@ -3793,7 +3791,7 @@
|
|
|
3793
3791
|
}
|
|
3794
3792
|
}
|
|
3795
3793
|
},
|
|
3796
|
-
"x-
|
|
3794
|
+
"x-f5xc-minimum-configuration": {
|
|
3797
3795
|
"description": "Minimum configuration for api_credentialApiCertificateType",
|
|
3798
3796
|
"required_fields": [
|
|
3799
3797
|
"password"
|
|
@@ -3803,7 +3801,7 @@
|
|
|
3803
3801
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"password\": \"value\"\n }\n}",
|
|
3804
3802
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_api_certificate_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3805
3803
|
},
|
|
3806
|
-
"x-
|
|
3804
|
+
"x-f5xc-cli-domain": "api"
|
|
3807
3805
|
},
|
|
3808
3806
|
"api_credentialBulkRevokeRequest": {
|
|
3809
3807
|
"type": "object",
|
|
@@ -3820,7 +3818,7 @@
|
|
|
3820
3818
|
"$ref": "#/components/schemas/api_credentialNameSelector"
|
|
3821
3819
|
}
|
|
3822
3820
|
},
|
|
3823
|
-
"x-
|
|
3821
|
+
"x-f5xc-minimum-configuration": {
|
|
3824
3822
|
"description": "Minimum configuration for api_credentialBulkRevokeRequest",
|
|
3825
3823
|
"required_fields": [
|
|
3826
3824
|
"expired_selector",
|
|
@@ -3831,7 +3829,7 @@
|
|
|
3831
3829
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"expired_selector\": \"value\",\n \"name_selector\": \"value\"\n }\n}",
|
|
3832
3830
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_bulk_revoke_requests\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3833
3831
|
},
|
|
3834
|
-
"x-
|
|
3832
|
+
"x-f5xc-cli-domain": "api"
|
|
3835
3833
|
},
|
|
3836
3834
|
"api_credentialBulkRevokeResponse": {
|
|
3837
3835
|
"type": "object",
|
|
@@ -3848,7 +3846,7 @@
|
|
|
3848
3846
|
"type": "string"
|
|
3849
3847
|
},
|
|
3850
3848
|
"x-displayname": "Credentials Failed.",
|
|
3851
|
-
"x-
|
|
3849
|
+
"x-f5xc-required-for": {
|
|
3852
3850
|
"minimum_config": false,
|
|
3853
3851
|
"create": false,
|
|
3854
3852
|
"update": false,
|
|
@@ -3863,7 +3861,7 @@
|
|
|
3863
3861
|
"type": "string"
|
|
3864
3862
|
},
|
|
3865
3863
|
"x-displayname": "Credentials Success.",
|
|
3866
|
-
"x-
|
|
3864
|
+
"x-f5xc-required-for": {
|
|
3867
3865
|
"minimum_config": false,
|
|
3868
3866
|
"create": false,
|
|
3869
3867
|
"update": false,
|
|
@@ -3877,7 +3875,7 @@
|
|
|
3877
3875
|
"x-displayname": "Error Message.",
|
|
3878
3876
|
"minLength": 0,
|
|
3879
3877
|
"maxLength": 1024,
|
|
3880
|
-
"x-
|
|
3878
|
+
"x-f5xc-required-for": {
|
|
3881
3879
|
"minimum_config": false,
|
|
3882
3880
|
"create": false,
|
|
3883
3881
|
"update": false,
|
|
@@ -3885,7 +3883,7 @@
|
|
|
3885
3883
|
}
|
|
3886
3884
|
}
|
|
3887
3885
|
},
|
|
3888
|
-
"x-
|
|
3886
|
+
"x-f5xc-minimum-configuration": {
|
|
3889
3887
|
"description": "Minimum configuration for api_credentialBulkRevokeResponse",
|
|
3890
3888
|
"required_fields": [
|
|
3891
3889
|
"credentials_failed",
|
|
@@ -3897,7 +3895,7 @@
|
|
|
3897
3895
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"credentials_failed\": \"value\",\n \"credentials_marked_for_deletion\": \"value\",\n \"error_message\": \"value\"\n }\n}",
|
|
3898
3896
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_bulk_revoke_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3899
3897
|
},
|
|
3900
|
-
"x-
|
|
3898
|
+
"x-f5xc-cli-domain": "api"
|
|
3901
3899
|
},
|
|
3902
3900
|
"api_credentialCreateRequest": {
|
|
3903
3901
|
"type": "object",
|
|
@@ -3914,9 +3912,10 @@
|
|
|
3914
3912
|
"format": "int64",
|
|
3915
3913
|
"x-displayname": "Expiry in days.",
|
|
3916
3914
|
"x-ves-example": "Value",
|
|
3915
|
+
"x-f5xc-example": "value",
|
|
3917
3916
|
"minimum": 0,
|
|
3918
3917
|
"maximum": 2147483647,
|
|
3919
|
-
"x-
|
|
3918
|
+
"x-f5xc-required-for": {
|
|
3920
3919
|
"minimum_config": false,
|
|
3921
3920
|
"create": false,
|
|
3922
3921
|
"update": false,
|
|
@@ -3929,9 +3928,10 @@
|
|
|
3929
3928
|
"title": "Name",
|
|
3930
3929
|
"x-displayname": "Name",
|
|
3931
3930
|
"x-ves-example": "Value",
|
|
3931
|
+
"x-f5xc-example": "value",
|
|
3932
3932
|
"minLength": 0,
|
|
3933
3933
|
"maxLength": 16,
|
|
3934
|
-
"x-
|
|
3934
|
+
"x-f5xc-required-for": {
|
|
3935
3935
|
"minimum_config": false,
|
|
3936
3936
|
"create": false,
|
|
3937
3937
|
"update": false,
|
|
@@ -3939,7 +3939,7 @@
|
|
|
3939
3939
|
},
|
|
3940
3940
|
"x-original-maxLength": 1024,
|
|
3941
3941
|
"x-reconciled-from-discovery": true,
|
|
3942
|
-
"x-reconciled-at": "2026-01-
|
|
3942
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431723+00:00"
|
|
3943
3943
|
},
|
|
3944
3944
|
"namespace": {
|
|
3945
3945
|
"type": "string",
|
|
@@ -3947,9 +3947,10 @@
|
|
|
3947
3947
|
"title": "Namespace",
|
|
3948
3948
|
"x-displayname": "Namespace",
|
|
3949
3949
|
"x-ves-example": "Value",
|
|
3950
|
+
"x-f5xc-example": "value",
|
|
3950
3951
|
"minLength": 0,
|
|
3951
3952
|
"maxLength": 6,
|
|
3952
|
-
"x-
|
|
3953
|
+
"x-f5xc-required-for": {
|
|
3953
3954
|
"minimum_config": false,
|
|
3954
3955
|
"create": false,
|
|
3955
3956
|
"update": false,
|
|
@@ -3957,13 +3958,13 @@
|
|
|
3957
3958
|
},
|
|
3958
3959
|
"x-original-maxLength": 1024,
|
|
3959
3960
|
"x-reconciled-from-discovery": true,
|
|
3960
|
-
"x-reconciled-at": "2026-01-
|
|
3961
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431730+00:00"
|
|
3961
3962
|
},
|
|
3962
3963
|
"spec": {
|
|
3963
3964
|
"$ref": "#/components/schemas/api_credentialCustomCreateSpecType"
|
|
3964
3965
|
}
|
|
3965
3966
|
},
|
|
3966
|
-
"x-
|
|
3967
|
+
"x-f5xc-minimum-configuration": {
|
|
3967
3968
|
"description": "Minimum configuration for api_credentialCreateRequest",
|
|
3968
3969
|
"required_fields": [
|
|
3969
3970
|
"expiration_days",
|
|
@@ -3976,7 +3977,7 @@
|
|
|
3976
3977
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"expiration_days\": \"value\",\n \"name\": \"value\",\n \"namespace\": \"value\",\n \"spec\": \"value\"\n }\n}",
|
|
3977
3978
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credentials\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
3978
3979
|
},
|
|
3979
|
-
"x-
|
|
3980
|
+
"x-f5xc-cli-domain": "api"
|
|
3980
3981
|
},
|
|
3981
3982
|
"api_credentialCreateResponse": {
|
|
3982
3983
|
"type": "object",
|
|
@@ -3989,7 +3990,7 @@
|
|
|
3989
3990
|
"active": {
|
|
3990
3991
|
"type": "boolean",
|
|
3991
3992
|
"format": "boolean",
|
|
3992
|
-
"x-
|
|
3993
|
+
"x-f5xc-required-for": {
|
|
3993
3994
|
"minimum_config": false,
|
|
3994
3995
|
"create": false,
|
|
3995
3996
|
"update": false,
|
|
@@ -4002,9 +4003,10 @@
|
|
|
4002
4003
|
"title": "Credentials.",
|
|
4003
4004
|
"x-displayname": "Credentials.",
|
|
4004
4005
|
"x-ves-example": "Value",
|
|
4006
|
+
"x-f5xc-example": "value",
|
|
4005
4007
|
"minLength": 0,
|
|
4006
4008
|
"maxLength": 1024,
|
|
4007
|
-
"x-
|
|
4009
|
+
"x-f5xc-required-for": {
|
|
4008
4010
|
"minimum_config": false,
|
|
4009
4011
|
"create": false,
|
|
4010
4012
|
"update": false,
|
|
@@ -4016,7 +4018,7 @@
|
|
|
4016
4018
|
"format": "date-time",
|
|
4017
4019
|
"minLength": 0,
|
|
4018
4020
|
"maxLength": 1024,
|
|
4019
|
-
"x-
|
|
4021
|
+
"x-f5xc-required-for": {
|
|
4020
4022
|
"minimum_config": false,
|
|
4021
4023
|
"create": false,
|
|
4022
4024
|
"update": false,
|
|
@@ -4026,10 +4028,10 @@
|
|
|
4026
4028
|
"name": {
|
|
4027
4029
|
"type": "string",
|
|
4028
4030
|
"description": "Human-readable name for the resource",
|
|
4029
|
-
"x-
|
|
4031
|
+
"x-f5xc-example": "example-resource",
|
|
4030
4032
|
"minLength": 0,
|
|
4031
4033
|
"maxLength": 16,
|
|
4032
|
-
"x-
|
|
4034
|
+
"x-f5xc-required-for": {
|
|
4033
4035
|
"minimum_config": false,
|
|
4034
4036
|
"create": false,
|
|
4035
4037
|
"update": false,
|
|
@@ -4037,10 +4039,10 @@
|
|
|
4037
4039
|
},
|
|
4038
4040
|
"x-original-maxLength": 1024,
|
|
4039
4041
|
"x-reconciled-from-discovery": true,
|
|
4040
|
-
"x-reconciled-at": "2026-01-
|
|
4042
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431741+00:00"
|
|
4041
4043
|
}
|
|
4042
4044
|
},
|
|
4043
|
-
"x-
|
|
4045
|
+
"x-f5xc-minimum-configuration": {
|
|
4044
4046
|
"description": "Minimum configuration for api_credentialCreateResponse",
|
|
4045
4047
|
"required_fields": [
|
|
4046
4048
|
"active",
|
|
@@ -4053,7 +4055,7 @@
|
|
|
4053
4055
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"active\": \"value\",\n \"data\": \"value\",\n \"expiration_timestamp\": \"value\",\n \"name\": \"value\"\n }\n}",
|
|
4054
4056
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credentials\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4055
4057
|
},
|
|
4056
|
-
"x-
|
|
4058
|
+
"x-f5xc-cli-domain": "api"
|
|
4057
4059
|
},
|
|
4058
4060
|
"api_credentialCreateServiceCredentialsRequest": {
|
|
4059
4061
|
"type": "object",
|
|
@@ -4076,9 +4078,10 @@
|
|
|
4076
4078
|
"format": "int64",
|
|
4077
4079
|
"x-displayname": "Expiry in days.",
|
|
4078
4080
|
"x-ves-example": "Value",
|
|
4081
|
+
"x-f5xc-example": "value",
|
|
4079
4082
|
"minimum": 0,
|
|
4080
4083
|
"maximum": 2147483647,
|
|
4081
|
-
"x-
|
|
4084
|
+
"x-f5xc-required-for": {
|
|
4082
4085
|
"minimum_config": false,
|
|
4083
4086
|
"create": false,
|
|
4084
4087
|
"update": false,
|
|
@@ -4091,9 +4094,10 @@
|
|
|
4091
4094
|
"title": "Name",
|
|
4092
4095
|
"x-displayname": "Name",
|
|
4093
4096
|
"x-ves-example": "Svc-cred-app1.",
|
|
4097
|
+
"x-f5xc-example": "svc-cred-app1",
|
|
4094
4098
|
"minLength": 0,
|
|
4095
4099
|
"maxLength": 16,
|
|
4096
|
-
"x-
|
|
4100
|
+
"x-f5xc-required-for": {
|
|
4097
4101
|
"minimum_config": false,
|
|
4098
4102
|
"create": false,
|
|
4099
4103
|
"update": false,
|
|
@@ -4101,7 +4105,7 @@
|
|
|
4101
4105
|
},
|
|
4102
4106
|
"x-original-maxLength": 1024,
|
|
4103
4107
|
"x-reconciled-from-discovery": true,
|
|
4104
|
-
"x-reconciled-at": "2026-01-
|
|
4108
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431750+00:00"
|
|
4105
4109
|
},
|
|
4106
4110
|
"namespace": {
|
|
4107
4111
|
"type": "string",
|
|
@@ -4109,9 +4113,10 @@
|
|
|
4109
4113
|
"title": "Namespace",
|
|
4110
4114
|
"x-displayname": "Namespace",
|
|
4111
4115
|
"x-ves-example": "System",
|
|
4116
|
+
"x-f5xc-example": "system",
|
|
4112
4117
|
"minLength": 0,
|
|
4113
4118
|
"maxLength": 6,
|
|
4114
|
-
"x-
|
|
4119
|
+
"x-f5xc-required-for": {
|
|
4115
4120
|
"minimum_config": false,
|
|
4116
4121
|
"create": false,
|
|
4117
4122
|
"update": false,
|
|
@@ -4119,7 +4124,7 @@
|
|
|
4119
4124
|
},
|
|
4120
4125
|
"x-original-maxLength": 1024,
|
|
4121
4126
|
"x-reconciled-from-discovery": true,
|
|
4122
|
-
"x-reconciled-at": "2026-01-
|
|
4127
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431755+00:00"
|
|
4123
4128
|
},
|
|
4124
4129
|
"namespace_roles": {
|
|
4125
4130
|
"type": "array",
|
|
@@ -4130,7 +4135,8 @@
|
|
|
4130
4135
|
},
|
|
4131
4136
|
"x-displayname": "List of roles.",
|
|
4132
4137
|
"x-ves-example": "Value",
|
|
4133
|
-
"x-
|
|
4138
|
+
"x-f5xc-example": "value",
|
|
4139
|
+
"x-f5xc-required-for": {
|
|
4134
4140
|
"minimum_config": false,
|
|
4135
4141
|
"create": false,
|
|
4136
4142
|
"update": false,
|
|
@@ -4147,13 +4153,13 @@
|
|
|
4147
4153
|
"x-ves-validation-rules": {
|
|
4148
4154
|
"ves.io.schema.rules.message.required": "true"
|
|
4149
4155
|
},
|
|
4156
|
+
"x-f5xc-example": "myPassw0rd123",
|
|
4150
4157
|
"x-validation-rules": {
|
|
4151
4158
|
"ves.io.schema.rules.message.required": "true"
|
|
4152
4159
|
},
|
|
4153
4160
|
"minLength": 0,
|
|
4154
4161
|
"maxLength": 1024,
|
|
4155
|
-
"
|
|
4156
|
-
"x-ves-required-for": {
|
|
4162
|
+
"x-f5xc-required-for": {
|
|
4157
4163
|
"minimum_config": false,
|
|
4158
4164
|
"create": false,
|
|
4159
4165
|
"update": false,
|
|
@@ -4175,7 +4181,8 @@
|
|
|
4175
4181
|
},
|
|
4176
4182
|
"x-displayname": "Groups",
|
|
4177
4183
|
"x-ves-example": "[\"dev-group-1\"]",
|
|
4178
|
-
"x-
|
|
4184
|
+
"x-f5xc-example": "\"[\"dev-group-1\"]\"",
|
|
4185
|
+
"x-f5xc-required-for": {
|
|
4179
4186
|
"minimum_config": false,
|
|
4180
4187
|
"create": false,
|
|
4181
4188
|
"update": false,
|
|
@@ -4188,9 +4195,10 @@
|
|
|
4188
4195
|
"title": "Virtual K8s cluster name.",
|
|
4189
4196
|
"x-displayname": "VK8s Cluster.",
|
|
4190
4197
|
"x-ves-example": "Vk8s-product-app1.",
|
|
4198
|
+
"x-f5xc-example": "vk8s-product-app1",
|
|
4191
4199
|
"minLength": 0,
|
|
4192
4200
|
"maxLength": 1024,
|
|
4193
|
-
"x-
|
|
4201
|
+
"x-f5xc-required-for": {
|
|
4194
4202
|
"minimum_config": false,
|
|
4195
4203
|
"create": false,
|
|
4196
4204
|
"update": false,
|
|
@@ -4203,9 +4211,10 @@
|
|
|
4203
4211
|
"title": "Virtual K8s namespace.",
|
|
4204
4212
|
"x-displayname": "VK8s Namespace.",
|
|
4205
4213
|
"x-ves-example": "App-ns1",
|
|
4214
|
+
"x-f5xc-example": "app-ns1",
|
|
4206
4215
|
"minLength": 0,
|
|
4207
4216
|
"maxLength": 1024,
|
|
4208
|
-
"x-
|
|
4217
|
+
"x-f5xc-required-for": {
|
|
4209
4218
|
"minimum_config": false,
|
|
4210
4219
|
"create": false,
|
|
4211
4220
|
"update": false,
|
|
@@ -4216,7 +4225,7 @@
|
|
|
4216
4225
|
"$ref": "#/components/schemas/api_credentialVk8sKubeconfigType"
|
|
4217
4226
|
}
|
|
4218
4227
|
},
|
|
4219
|
-
"x-
|
|
4228
|
+
"x-f5xc-minimum-configuration": {
|
|
4220
4229
|
"description": "Minimum configuration for api_credentialCreateServiceCredentialsRequest",
|
|
4221
4230
|
"required_fields": [
|
|
4222
4231
|
"api_certificate",
|
|
@@ -4238,7 +4247,7 @@
|
|
|
4238
4247
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"api_certificate\": \"value\",\n \"api_token\": \"value\",\n \"expiration_days\": \"value\",\n \"name\": \"value\",\n \"namespace\": \"value\"\n }\n}",
|
|
4239
4248
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credentials\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4240
4249
|
},
|
|
4241
|
-
"x-
|
|
4250
|
+
"x-f5xc-cli-domain": "api"
|
|
4242
4251
|
},
|
|
4243
4252
|
"api_credentialCustomCreateSpecType": {
|
|
4244
4253
|
"type": "object",
|
|
@@ -4258,13 +4267,13 @@
|
|
|
4258
4267
|
"x-ves-validation-rules": {
|
|
4259
4268
|
"ves.io.schema.rules.message.required": "true"
|
|
4260
4269
|
},
|
|
4270
|
+
"x-f5xc-example": "myPassw0rd123",
|
|
4261
4271
|
"x-validation-rules": {
|
|
4262
4272
|
"ves.io.schema.rules.message.required": "true"
|
|
4263
4273
|
},
|
|
4264
4274
|
"minLength": 0,
|
|
4265
4275
|
"maxLength": 1024,
|
|
4266
|
-
"
|
|
4267
|
-
"x-ves-required-for": {
|
|
4276
|
+
"x-f5xc-required-for": {
|
|
4268
4277
|
"minimum_config": false,
|
|
4269
4278
|
"create": false,
|
|
4270
4279
|
"update": false,
|
|
@@ -4280,9 +4289,10 @@
|
|
|
4280
4289
|
"title": "Virtual K8s cluster name.",
|
|
4281
4290
|
"x-displayname": "VK8s Cluster.",
|
|
4282
4291
|
"x-ves-example": "Vk8s-product-app1.",
|
|
4292
|
+
"x-f5xc-example": "vk8s-product-app1",
|
|
4283
4293
|
"minLength": 0,
|
|
4284
4294
|
"maxLength": 1024,
|
|
4285
|
-
"x-
|
|
4295
|
+
"x-f5xc-required-for": {
|
|
4286
4296
|
"minimum_config": false,
|
|
4287
4297
|
"create": false,
|
|
4288
4298
|
"update": false,
|
|
@@ -4295,9 +4305,10 @@
|
|
|
4295
4305
|
"title": "Virtual K8s namespace.",
|
|
4296
4306
|
"x-displayname": "VK8s Namespace.",
|
|
4297
4307
|
"x-ves-example": "App-ns1",
|
|
4308
|
+
"x-f5xc-example": "app-ns1",
|
|
4298
4309
|
"minLength": 0,
|
|
4299
4310
|
"maxLength": 1024,
|
|
4300
|
-
"x-
|
|
4311
|
+
"x-f5xc-required-for": {
|
|
4301
4312
|
"minimum_config": false,
|
|
4302
4313
|
"create": false,
|
|
4303
4314
|
"update": false,
|
|
@@ -4305,7 +4316,7 @@
|
|
|
4305
4316
|
}
|
|
4306
4317
|
}
|
|
4307
4318
|
},
|
|
4308
|
-
"x-
|
|
4319
|
+
"x-f5xc-minimum-configuration": {
|
|
4309
4320
|
"description": "Minimum configuration for api_credentialCustomCreateSpecType",
|
|
4310
4321
|
"required_fields": [
|
|
4311
4322
|
"password",
|
|
@@ -4318,7 +4329,7 @@
|
|
|
4318
4329
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"password\": \"value\",\n \"type\": \"value\",\n \"virtual_k8s_name\": \"value\",\n \"virtual_k8s_namespace\": \"value\"\n }\n}",
|
|
4319
4330
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_customs\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4320
4331
|
},
|
|
4321
|
-
"x-
|
|
4332
|
+
"x-f5xc-cli-domain": "api"
|
|
4322
4333
|
},
|
|
4323
4334
|
"api_credentialExpiredSelector": {
|
|
4324
4335
|
"type": "object",
|
|
@@ -4335,7 +4346,7 @@
|
|
|
4335
4346
|
"$ref": "#/components/schemas/api_credentialAPICredentialType"
|
|
4336
4347
|
}
|
|
4337
4348
|
},
|
|
4338
|
-
"x-
|
|
4349
|
+
"x-f5xc-minimum-configuration": {
|
|
4339
4350
|
"description": "Minimum configuration for api_credentialExpiredSelector",
|
|
4340
4351
|
"required_fields": [
|
|
4341
4352
|
"all",
|
|
@@ -4346,7 +4357,7 @@
|
|
|
4346
4357
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"all\": \"value\",\n \"credential_type\": \"value\"\n }\n}",
|
|
4347
4358
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_expired_selectors\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4348
4359
|
},
|
|
4349
|
-
"x-
|
|
4360
|
+
"x-f5xc-cli-domain": "api"
|
|
4350
4361
|
},
|
|
4351
4362
|
"api_credentialGetRequest": {
|
|
4352
4363
|
"type": "object",
|
|
@@ -4365,13 +4376,13 @@
|
|
|
4365
4376
|
"x-ves-validation-rules": {
|
|
4366
4377
|
"ves.io.schema.rules.message.required": "true"
|
|
4367
4378
|
},
|
|
4379
|
+
"x-f5xc-example": "value",
|
|
4368
4380
|
"x-validation-rules": {
|
|
4369
4381
|
"ves.io.schema.rules.message.required": "true"
|
|
4370
4382
|
},
|
|
4371
4383
|
"minLength": 0,
|
|
4372
4384
|
"maxLength": 16,
|
|
4373
|
-
"
|
|
4374
|
-
"x-ves-required-for": {
|
|
4385
|
+
"x-f5xc-required-for": {
|
|
4375
4386
|
"minimum_config": false,
|
|
4376
4387
|
"create": false,
|
|
4377
4388
|
"update": false,
|
|
@@ -4379,7 +4390,7 @@
|
|
|
4379
4390
|
},
|
|
4380
4391
|
"x-original-maxLength": 1024,
|
|
4381
4392
|
"x-reconciled-from-discovery": true,
|
|
4382
|
-
"x-reconciled-at": "2026-01-
|
|
4393
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431779+00:00"
|
|
4383
4394
|
},
|
|
4384
4395
|
"namespace": {
|
|
4385
4396
|
"type": "string",
|
|
@@ -4391,13 +4402,13 @@
|
|
|
4391
4402
|
"x-ves-validation-rules": {
|
|
4392
4403
|
"ves.io.schema.rules.message.required": "true"
|
|
4393
4404
|
},
|
|
4405
|
+
"x-f5xc-example": "system",
|
|
4394
4406
|
"x-validation-rules": {
|
|
4395
4407
|
"ves.io.schema.rules.message.required": "true"
|
|
4396
4408
|
},
|
|
4397
4409
|
"minLength": 0,
|
|
4398
4410
|
"maxLength": 6,
|
|
4399
|
-
"
|
|
4400
|
-
"x-ves-required-for": {
|
|
4411
|
+
"x-f5xc-required-for": {
|
|
4401
4412
|
"minimum_config": false,
|
|
4402
4413
|
"create": false,
|
|
4403
4414
|
"update": false,
|
|
@@ -4405,10 +4416,10 @@
|
|
|
4405
4416
|
},
|
|
4406
4417
|
"x-original-maxLength": 1024,
|
|
4407
4418
|
"x-reconciled-from-discovery": true,
|
|
4408
|
-
"x-reconciled-at": "2026-01-
|
|
4419
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431783+00:00"
|
|
4409
4420
|
}
|
|
4410
4421
|
},
|
|
4411
|
-
"x-
|
|
4422
|
+
"x-f5xc-minimum-configuration": {
|
|
4412
4423
|
"description": "Minimum configuration for api_credentialGetRequest",
|
|
4413
4424
|
"required_fields": [
|
|
4414
4425
|
"name",
|
|
@@ -4419,7 +4430,7 @@
|
|
|
4419
4430
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"name\": \"value\",\n \"namespace\": \"value\"\n }\n}",
|
|
4420
4431
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credentials\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4421
4432
|
},
|
|
4422
|
-
"x-
|
|
4433
|
+
"x-f5xc-cli-domain": "api"
|
|
4423
4434
|
},
|
|
4424
4435
|
"api_credentialGetResponse": {
|
|
4425
4436
|
"type": "object",
|
|
@@ -4432,7 +4443,7 @@
|
|
|
4432
4443
|
"$ref": "#/components/schemas/api_credentialObject"
|
|
4433
4444
|
}
|
|
4434
4445
|
},
|
|
4435
|
-
"x-
|
|
4446
|
+
"x-f5xc-minimum-configuration": {
|
|
4436
4447
|
"description": "Minimum configuration for api_credentialGetResponse",
|
|
4437
4448
|
"required_fields": [
|
|
4438
4449
|
"object"
|
|
@@ -4442,7 +4453,7 @@
|
|
|
4442
4453
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"object\": \"value\"\n }\n}",
|
|
4443
4454
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credentials\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4444
4455
|
},
|
|
4445
|
-
"x-
|
|
4456
|
+
"x-f5xc-cli-domain": "api"
|
|
4446
4457
|
},
|
|
4447
4458
|
"api_credentialGetServiceCredentialsResponse": {
|
|
4448
4459
|
"type": "object",
|
|
@@ -4458,7 +4469,8 @@
|
|
|
4458
4469
|
"format": "boolean",
|
|
4459
4470
|
"x-displayname": "Active",
|
|
4460
4471
|
"x-ves-example": "True",
|
|
4461
|
-
"x-
|
|
4472
|
+
"x-f5xc-example": "true",
|
|
4473
|
+
"x-f5xc-required-for": {
|
|
4462
4474
|
"minimum_config": false,
|
|
4463
4475
|
"create": false,
|
|
4464
4476
|
"update": false,
|
|
@@ -4473,7 +4485,7 @@
|
|
|
4473
4485
|
"x-displayname": "Creation Time.",
|
|
4474
4486
|
"minLength": 0,
|
|
4475
4487
|
"maxLength": 1024,
|
|
4476
|
-
"x-
|
|
4488
|
+
"x-f5xc-required-for": {
|
|
4477
4489
|
"minimum_config": false,
|
|
4478
4490
|
"create": false,
|
|
4479
4491
|
"update": false,
|
|
@@ -4488,7 +4500,7 @@
|
|
|
4488
4500
|
"x-displayname": "Expiry Time.",
|
|
4489
4501
|
"minLength": 0,
|
|
4490
4502
|
"maxLength": 1024,
|
|
4491
|
-
"x-
|
|
4503
|
+
"x-f5xc-required-for": {
|
|
4492
4504
|
"minimum_config": false,
|
|
4493
4505
|
"create": false,
|
|
4494
4506
|
"update": false,
|
|
@@ -4501,9 +4513,10 @@
|
|
|
4501
4513
|
"title": "Credential name.",
|
|
4502
4514
|
"x-displayname": "Name",
|
|
4503
4515
|
"x-ves-example": "Value",
|
|
4516
|
+
"x-f5xc-example": "value",
|
|
4504
4517
|
"minLength": 0,
|
|
4505
4518
|
"maxLength": 16,
|
|
4506
|
-
"x-
|
|
4519
|
+
"x-f5xc-required-for": {
|
|
4507
4520
|
"minimum_config": false,
|
|
4508
4521
|
"create": false,
|
|
4509
4522
|
"update": false,
|
|
@@ -4511,7 +4524,7 @@
|
|
|
4511
4524
|
},
|
|
4512
4525
|
"x-original-maxLength": 1024,
|
|
4513
4526
|
"x-reconciled-from-discovery": true,
|
|
4514
|
-
"x-reconciled-at": "2026-01-
|
|
4527
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431794+00:00"
|
|
4515
4528
|
},
|
|
4516
4529
|
"namespace": {
|
|
4517
4530
|
"type": "string",
|
|
@@ -4519,9 +4532,10 @@
|
|
|
4519
4532
|
"title": "Namespace",
|
|
4520
4533
|
"x-displayname": "Namespace",
|
|
4521
4534
|
"x-ves-example": "System",
|
|
4535
|
+
"x-f5xc-example": "system",
|
|
4522
4536
|
"minLength": 0,
|
|
4523
4537
|
"maxLength": 6,
|
|
4524
|
-
"x-
|
|
4538
|
+
"x-f5xc-required-for": {
|
|
4525
4539
|
"minimum_config": false,
|
|
4526
4540
|
"create": false,
|
|
4527
4541
|
"update": false,
|
|
@@ -4529,7 +4543,7 @@
|
|
|
4529
4543
|
},
|
|
4530
4544
|
"x-original-maxLength": 1024,
|
|
4531
4545
|
"x-reconciled-from-discovery": true,
|
|
4532
|
-
"x-reconciled-at": "2026-01-
|
|
4546
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431798+00:00"
|
|
4533
4547
|
},
|
|
4534
4548
|
"namespace_access": {
|
|
4535
4549
|
"$ref": "#/components/schemas/schemaNamespaceAccessType"
|
|
@@ -4543,9 +4557,10 @@
|
|
|
4543
4557
|
"title": "Uid of the record.",
|
|
4544
4558
|
"x-displayname": "UUID",
|
|
4545
4559
|
"x-ves-example": "Fa45979f-4e41-4f4b-8b0b-c3ab844ab0aa.",
|
|
4560
|
+
"x-f5xc-example": "fa45979f-4e41-4f4b-8b0b-c3ab844ab0aa",
|
|
4546
4561
|
"minLength": 0,
|
|
4547
4562
|
"maxLength": 36,
|
|
4548
|
-
"x-
|
|
4563
|
+
"x-f5xc-required-for": {
|
|
4549
4564
|
"minimum_config": false,
|
|
4550
4565
|
"create": false,
|
|
4551
4566
|
"update": false,
|
|
@@ -4555,7 +4570,7 @@
|
|
|
4555
4570
|
"x-original-maxLength": 1024,
|
|
4556
4571
|
"format": "uuid",
|
|
4557
4572
|
"x-reconciled-from-discovery": true,
|
|
4558
|
-
"x-reconciled-at": "2026-01-
|
|
4573
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431806+00:00"
|
|
4559
4574
|
},
|
|
4560
4575
|
"user_email": {
|
|
4561
4576
|
"type": "string",
|
|
@@ -4563,9 +4578,10 @@
|
|
|
4563
4578
|
"title": "Email of user.",
|
|
4564
4579
|
"x-displayname": "User",
|
|
4565
4580
|
"x-ves-example": "Admin@example-corp.com.",
|
|
4581
|
+
"x-f5xc-example": "admin@example-corp.com",
|
|
4566
4582
|
"minLength": 0,
|
|
4567
4583
|
"maxLength": 1024,
|
|
4568
|
-
"x-
|
|
4584
|
+
"x-f5xc-required-for": {
|
|
4569
4585
|
"minimum_config": false,
|
|
4570
4586
|
"create": false,
|
|
4571
4587
|
"update": false,
|
|
@@ -4581,7 +4597,8 @@
|
|
|
4581
4597
|
},
|
|
4582
4598
|
"x-displayname": "User Groups.",
|
|
4583
4599
|
"x-ves-example": "[\"dev-group-1\"]",
|
|
4584
|
-
"x-
|
|
4600
|
+
"x-f5xc-example": "\"[\"dev-group-1\"]\"",
|
|
4601
|
+
"x-f5xc-required-for": {
|
|
4585
4602
|
"minimum_config": false,
|
|
4586
4603
|
"create": false,
|
|
4587
4604
|
"update": false,
|
|
@@ -4589,7 +4606,7 @@
|
|
|
4589
4606
|
}
|
|
4590
4607
|
}
|
|
4591
4608
|
},
|
|
4592
|
-
"x-
|
|
4609
|
+
"x-f5xc-minimum-configuration": {
|
|
4593
4610
|
"description": "Minimum configuration for api_credentialGetServiceCredentialsResponse",
|
|
4594
4611
|
"required_fields": [
|
|
4595
4612
|
"active",
|
|
@@ -4608,7 +4625,7 @@
|
|
|
4608
4625
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"active\": \"value\",\n \"create_timestamp\": \"value\",\n \"expiry_timestamp\": \"value\",\n \"name\": \"value\",\n \"namespace\": \"value\"\n }\n}",
|
|
4609
4626
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credentials\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4610
4627
|
},
|
|
4611
|
-
"x-
|
|
4628
|
+
"x-f5xc-cli-domain": "api"
|
|
4612
4629
|
},
|
|
4613
4630
|
"api_credentialGlobalSpecType": {
|
|
4614
4631
|
"type": "object",
|
|
@@ -4623,7 +4640,7 @@
|
|
|
4623
4640
|
"title": "Active",
|
|
4624
4641
|
"format": "boolean",
|
|
4625
4642
|
"x-displayname": "Active",
|
|
4626
|
-
"x-
|
|
4643
|
+
"x-f5xc-required-for": {
|
|
4627
4644
|
"minimum_config": false,
|
|
4628
4645
|
"create": false,
|
|
4629
4646
|
"update": false,
|
|
@@ -4643,8 +4660,7 @@
|
|
|
4643
4660
|
"ves.io.schema.rules.string.max_len": "32"
|
|
4644
4661
|
},
|
|
4645
4662
|
"minLength": 0,
|
|
4646
|
-
"
|
|
4647
|
-
"x-ves-required-for": {
|
|
4663
|
+
"x-f5xc-required-for": {
|
|
4648
4664
|
"minimum_config": false,
|
|
4649
4665
|
"create": false,
|
|
4650
4666
|
"update": false,
|
|
@@ -4659,7 +4675,7 @@
|
|
|
4659
4675
|
"x-displayname": "Created timestamp.",
|
|
4660
4676
|
"minLength": 0,
|
|
4661
4677
|
"maxLength": 1024,
|
|
4662
|
-
"x-
|
|
4678
|
+
"x-f5xc-required-for": {
|
|
4663
4679
|
"minimum_config": false,
|
|
4664
4680
|
"create": false,
|
|
4665
4681
|
"update": false,
|
|
@@ -4673,7 +4689,7 @@
|
|
|
4673
4689
|
"x-displayname": "Digest sha1.",
|
|
4674
4690
|
"minLength": 0,
|
|
4675
4691
|
"maxLength": 1024,
|
|
4676
|
-
"x-
|
|
4692
|
+
"x-f5xc-required-for": {
|
|
4677
4693
|
"minimum_config": false,
|
|
4678
4694
|
"create": false,
|
|
4679
4695
|
"update": false,
|
|
@@ -4688,7 +4704,7 @@
|
|
|
4688
4704
|
"x-displayname": "Expiry timestamp.",
|
|
4689
4705
|
"minLength": 0,
|
|
4690
4706
|
"maxLength": 1024,
|
|
4691
|
-
"x-
|
|
4707
|
+
"x-f5xc-required-for": {
|
|
4692
4708
|
"minimum_config": false,
|
|
4693
4709
|
"create": false,
|
|
4694
4710
|
"update": false,
|
|
@@ -4702,7 +4718,7 @@
|
|
|
4702
4718
|
"x-displayname": "Site Name",
|
|
4703
4719
|
"minLength": 0,
|
|
4704
4720
|
"maxLength": 1024,
|
|
4705
|
-
"x-
|
|
4721
|
+
"x-f5xc-required-for": {
|
|
4706
4722
|
"minimum_config": false,
|
|
4707
4723
|
"create": false,
|
|
4708
4724
|
"update": false,
|
|
@@ -4727,8 +4743,7 @@
|
|
|
4727
4743
|
"x-validation-rules": {
|
|
4728
4744
|
"ves.io.schema.rules.repeated.max_items": "1"
|
|
4729
4745
|
},
|
|
4730
|
-
"
|
|
4731
|
-
"x-ves-required-for": {
|
|
4746
|
+
"x-f5xc-required-for": {
|
|
4732
4747
|
"minimum_config": false,
|
|
4733
4748
|
"create": false,
|
|
4734
4749
|
"update": false,
|
|
@@ -4742,7 +4757,7 @@
|
|
|
4742
4757
|
"x-displayname": "Virtual K8s.",
|
|
4743
4758
|
"minLength": 0,
|
|
4744
4759
|
"maxLength": 1024,
|
|
4745
|
-
"x-
|
|
4760
|
+
"x-f5xc-required-for": {
|
|
4746
4761
|
"minimum_config": false,
|
|
4747
4762
|
"create": false,
|
|
4748
4763
|
"update": false,
|
|
@@ -4756,7 +4771,7 @@
|
|
|
4756
4771
|
"x-displayname": "Namespace",
|
|
4757
4772
|
"minLength": 0,
|
|
4758
4773
|
"maxLength": 1024,
|
|
4759
|
-
"x-
|
|
4774
|
+
"x-f5xc-required-for": {
|
|
4760
4775
|
"minimum_config": false,
|
|
4761
4776
|
"create": false,
|
|
4762
4777
|
"update": false,
|
|
@@ -4764,7 +4779,7 @@
|
|
|
4764
4779
|
}
|
|
4765
4780
|
}
|
|
4766
4781
|
},
|
|
4767
|
-
"x-
|
|
4782
|
+
"x-f5xc-minimum-configuration": {
|
|
4768
4783
|
"description": "Minimum configuration for api_credentialGlobalSpecType",
|
|
4769
4784
|
"required_fields": [
|
|
4770
4785
|
"active",
|
|
@@ -4783,7 +4798,7 @@
|
|
|
4783
4798
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"active\": \"value\",\n \"certificate_serial_num\": \"value\",\n \"created_timestamp\": \"value\",\n \"digest\": \"value\",\n \"expiration_timestamp\": \"value\"\n }\n}",
|
|
4784
4799
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_global_spec_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4785
4800
|
},
|
|
4786
|
-
"x-
|
|
4801
|
+
"x-f5xc-cli-domain": "api"
|
|
4787
4802
|
},
|
|
4788
4803
|
"api_credentialListResponse": {
|
|
4789
4804
|
"type": "object",
|
|
@@ -4800,7 +4815,7 @@
|
|
|
4800
4815
|
"$ref": "#/components/schemas/api_credentialListResponseItem"
|
|
4801
4816
|
},
|
|
4802
4817
|
"x-displayname": "Credentials.",
|
|
4803
|
-
"x-
|
|
4818
|
+
"x-f5xc-required-for": {
|
|
4804
4819
|
"minimum_config": false,
|
|
4805
4820
|
"create": false,
|
|
4806
4821
|
"update": false,
|
|
@@ -4808,7 +4823,7 @@
|
|
|
4808
4823
|
}
|
|
4809
4824
|
}
|
|
4810
4825
|
},
|
|
4811
|
-
"x-
|
|
4826
|
+
"x-f5xc-minimum-configuration": {
|
|
4812
4827
|
"description": "Minimum configuration for api_credentialListResponse",
|
|
4813
4828
|
"required_fields": [
|
|
4814
4829
|
"items"
|
|
@@ -4818,7 +4833,7 @@
|
|
|
4818
4833
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"items\": \"value\"\n }\n}",
|
|
4819
4834
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_list_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4820
4835
|
},
|
|
4821
|
-
"x-
|
|
4836
|
+
"x-f5xc-cli-domain": "api"
|
|
4822
4837
|
},
|
|
4823
4838
|
"api_credentialListResponseItem": {
|
|
4824
4839
|
"type": "object",
|
|
@@ -4834,7 +4849,8 @@
|
|
|
4834
4849
|
"format": "boolean",
|
|
4835
4850
|
"x-displayname": "Active",
|
|
4836
4851
|
"x-ves-example": "True",
|
|
4837
|
-
"x-
|
|
4852
|
+
"x-f5xc-example": "true",
|
|
4853
|
+
"x-f5xc-required-for": {
|
|
4838
4854
|
"minimum_config": false,
|
|
4839
4855
|
"create": false,
|
|
4840
4856
|
"update": false,
|
|
@@ -4849,7 +4865,7 @@
|
|
|
4849
4865
|
"x-displayname": "Creation Time.",
|
|
4850
4866
|
"minLength": 0,
|
|
4851
4867
|
"maxLength": 1024,
|
|
4852
|
-
"x-
|
|
4868
|
+
"x-f5xc-required-for": {
|
|
4853
4869
|
"minimum_config": false,
|
|
4854
4870
|
"create": false,
|
|
4855
4871
|
"update": false,
|
|
@@ -4864,7 +4880,7 @@
|
|
|
4864
4880
|
"x-displayname": "Expiry Time.",
|
|
4865
4881
|
"minLength": 0,
|
|
4866
4882
|
"maxLength": 1024,
|
|
4867
|
-
"x-
|
|
4883
|
+
"x-f5xc-required-for": {
|
|
4868
4884
|
"minimum_config": false,
|
|
4869
4885
|
"create": false,
|
|
4870
4886
|
"update": false,
|
|
@@ -4877,9 +4893,10 @@
|
|
|
4877
4893
|
"title": "Credential name.",
|
|
4878
4894
|
"x-displayname": "Name",
|
|
4879
4895
|
"x-ves-example": "Value",
|
|
4896
|
+
"x-f5xc-example": "value",
|
|
4880
4897
|
"minLength": 0,
|
|
4881
4898
|
"maxLength": 16,
|
|
4882
|
-
"x-
|
|
4899
|
+
"x-f5xc-required-for": {
|
|
4883
4900
|
"minimum_config": false,
|
|
4884
4901
|
"create": false,
|
|
4885
4902
|
"update": false,
|
|
@@ -4887,7 +4904,7 @@
|
|
|
4887
4904
|
},
|
|
4888
4905
|
"x-original-maxLength": 1024,
|
|
4889
4906
|
"x-reconciled-from-discovery": true,
|
|
4890
|
-
"x-reconciled-at": "2026-01-
|
|
4907
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431834+00:00"
|
|
4891
4908
|
},
|
|
4892
4909
|
"namespace": {
|
|
4893
4910
|
"type": "string",
|
|
@@ -4895,9 +4912,10 @@
|
|
|
4895
4912
|
"title": "Namespace",
|
|
4896
4913
|
"x-displayname": "Namespace",
|
|
4897
4914
|
"x-ves-example": "System",
|
|
4915
|
+
"x-f5xc-example": "system",
|
|
4898
4916
|
"minLength": 0,
|
|
4899
4917
|
"maxLength": 6,
|
|
4900
|
-
"x-
|
|
4918
|
+
"x-f5xc-required-for": {
|
|
4901
4919
|
"minimum_config": false,
|
|
4902
4920
|
"create": false,
|
|
4903
4921
|
"update": false,
|
|
@@ -4905,7 +4923,7 @@
|
|
|
4905
4923
|
},
|
|
4906
4924
|
"x-original-maxLength": 1024,
|
|
4907
4925
|
"x-reconciled-from-discovery": true,
|
|
4908
|
-
"x-reconciled-at": "2026-01-
|
|
4926
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431839+00:00"
|
|
4909
4927
|
},
|
|
4910
4928
|
"type": {
|
|
4911
4929
|
"$ref": "#/components/schemas/api_credentialAPICredentialType"
|
|
@@ -4916,9 +4934,10 @@
|
|
|
4916
4934
|
"title": "UUID of the record.",
|
|
4917
4935
|
"x-displayname": "UUID",
|
|
4918
4936
|
"x-ves-example": "Fa45979f-4e41-4f4b-8b0b-c3ab844ab0aa.",
|
|
4937
|
+
"x-f5xc-example": "fa45979f-4e41-4f4b-8b0b-c3ab844ab0aa",
|
|
4919
4938
|
"minLength": 0,
|
|
4920
4939
|
"maxLength": 36,
|
|
4921
|
-
"x-
|
|
4940
|
+
"x-f5xc-required-for": {
|
|
4922
4941
|
"minimum_config": false,
|
|
4923
4942
|
"create": false,
|
|
4924
4943
|
"update": false,
|
|
@@ -4928,7 +4947,7 @@
|
|
|
4928
4947
|
"x-original-maxLength": 1024,
|
|
4929
4948
|
"format": "uuid",
|
|
4930
4949
|
"x-reconciled-from-discovery": true,
|
|
4931
|
-
"x-reconciled-at": "2026-01-
|
|
4950
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431845+00:00"
|
|
4932
4951
|
},
|
|
4933
4952
|
"user_email": {
|
|
4934
4953
|
"type": "string",
|
|
@@ -4936,9 +4955,10 @@
|
|
|
4936
4955
|
"title": "Email of user.",
|
|
4937
4956
|
"x-displayname": "User",
|
|
4938
4957
|
"x-ves-example": "Admin@example-corp.com.",
|
|
4958
|
+
"x-f5xc-example": "admin@example-corp.com",
|
|
4939
4959
|
"minLength": 0,
|
|
4940
4960
|
"maxLength": 1024,
|
|
4941
|
-
"x-
|
|
4961
|
+
"x-f5xc-required-for": {
|
|
4942
4962
|
"minimum_config": false,
|
|
4943
4963
|
"create": false,
|
|
4944
4964
|
"update": false,
|
|
@@ -4946,7 +4966,7 @@
|
|
|
4946
4966
|
}
|
|
4947
4967
|
}
|
|
4948
4968
|
},
|
|
4949
|
-
"x-
|
|
4969
|
+
"x-f5xc-minimum-configuration": {
|
|
4950
4970
|
"description": "Minimum configuration for api_credentialListResponseItem",
|
|
4951
4971
|
"required_fields": [
|
|
4952
4972
|
"active",
|
|
@@ -4963,7 +4983,7 @@
|
|
|
4963
4983
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"active\": \"value\",\n \"create_timestamp\": \"value\",\n \"expiry_timestamp\": \"value\",\n \"name\": \"value\",\n \"namespace\": \"value\"\n }\n}",
|
|
4964
4984
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_list_response_items\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
4965
4985
|
},
|
|
4966
|
-
"x-
|
|
4986
|
+
"x-f5xc-cli-domain": "api"
|
|
4967
4987
|
},
|
|
4968
4988
|
"api_credentialListServiceCredentialsResponse": {
|
|
4969
4989
|
"type": "object",
|
|
@@ -4980,7 +5000,7 @@
|
|
|
4980
5000
|
"$ref": "#/components/schemas/api_credentialListServiceCredentialsResponseItem"
|
|
4981
5001
|
},
|
|
4982
5002
|
"x-displayname": "Service Credentials.",
|
|
4983
|
-
"x-
|
|
5003
|
+
"x-f5xc-required-for": {
|
|
4984
5004
|
"minimum_config": false,
|
|
4985
5005
|
"create": false,
|
|
4986
5006
|
"update": false,
|
|
@@ -4988,7 +5008,7 @@
|
|
|
4988
5008
|
}
|
|
4989
5009
|
}
|
|
4990
5010
|
},
|
|
4991
|
-
"x-
|
|
5011
|
+
"x-f5xc-minimum-configuration": {
|
|
4992
5012
|
"description": "Minimum configuration for api_credentialListServiceCredentialsResponse",
|
|
4993
5013
|
"required_fields": [
|
|
4994
5014
|
"items"
|
|
@@ -4998,7 +5018,7 @@
|
|
|
4998
5018
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"items\": \"value\"\n }\n}",
|
|
4999
5019
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_list_service_credentials_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5000
5020
|
},
|
|
5001
|
-
"x-
|
|
5021
|
+
"x-f5xc-cli-domain": "api"
|
|
5002
5022
|
},
|
|
5003
5023
|
"api_credentialListServiceCredentialsResponseItem": {
|
|
5004
5024
|
"type": "object",
|
|
@@ -5014,7 +5034,8 @@
|
|
|
5014
5034
|
"format": "boolean",
|
|
5015
5035
|
"x-displayname": "Active",
|
|
5016
5036
|
"x-ves-example": "True",
|
|
5017
|
-
"x-
|
|
5037
|
+
"x-f5xc-example": "true",
|
|
5038
|
+
"x-f5xc-required-for": {
|
|
5018
5039
|
"minimum_config": false,
|
|
5019
5040
|
"create": false,
|
|
5020
5041
|
"update": false,
|
|
@@ -5029,7 +5050,7 @@
|
|
|
5029
5050
|
"x-displayname": "Creation Time.",
|
|
5030
5051
|
"minLength": 0,
|
|
5031
5052
|
"maxLength": 1024,
|
|
5032
|
-
"x-
|
|
5053
|
+
"x-f5xc-required-for": {
|
|
5033
5054
|
"minimum_config": false,
|
|
5034
5055
|
"create": false,
|
|
5035
5056
|
"update": false,
|
|
@@ -5044,7 +5065,7 @@
|
|
|
5044
5065
|
"x-displayname": "Expiry Time.",
|
|
5045
5066
|
"minLength": 0,
|
|
5046
5067
|
"maxLength": 1024,
|
|
5047
|
-
"x-
|
|
5068
|
+
"x-f5xc-required-for": {
|
|
5048
5069
|
"minimum_config": false,
|
|
5049
5070
|
"create": false,
|
|
5050
5071
|
"update": false,
|
|
@@ -5057,9 +5078,10 @@
|
|
|
5057
5078
|
"title": "Credential name.",
|
|
5058
5079
|
"x-displayname": "Name",
|
|
5059
5080
|
"x-ves-example": "Value",
|
|
5081
|
+
"x-f5xc-example": "value",
|
|
5060
5082
|
"minLength": 0,
|
|
5061
5083
|
"maxLength": 16,
|
|
5062
|
-
"x-
|
|
5084
|
+
"x-f5xc-required-for": {
|
|
5063
5085
|
"minimum_config": false,
|
|
5064
5086
|
"create": false,
|
|
5065
5087
|
"update": false,
|
|
@@ -5067,7 +5089,7 @@
|
|
|
5067
5089
|
},
|
|
5068
5090
|
"x-original-maxLength": 1024,
|
|
5069
5091
|
"x-reconciled-from-discovery": true,
|
|
5070
|
-
"x-reconciled-at": "2026-01-
|
|
5092
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431857+00:00"
|
|
5071
5093
|
},
|
|
5072
5094
|
"namespace": {
|
|
5073
5095
|
"type": "string",
|
|
@@ -5075,9 +5097,10 @@
|
|
|
5075
5097
|
"title": "Namespace",
|
|
5076
5098
|
"x-displayname": "Namespace",
|
|
5077
5099
|
"x-ves-example": "System",
|
|
5100
|
+
"x-f5xc-example": "system",
|
|
5078
5101
|
"minLength": 0,
|
|
5079
5102
|
"maxLength": 6,
|
|
5080
|
-
"x-
|
|
5103
|
+
"x-f5xc-required-for": {
|
|
5081
5104
|
"minimum_config": false,
|
|
5082
5105
|
"create": false,
|
|
5083
5106
|
"update": false,
|
|
@@ -5085,7 +5108,7 @@
|
|
|
5085
5108
|
},
|
|
5086
5109
|
"x-original-maxLength": 1024,
|
|
5087
5110
|
"x-reconciled-from-discovery": true,
|
|
5088
|
-
"x-reconciled-at": "2026-01-
|
|
5111
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431861+00:00"
|
|
5089
5112
|
},
|
|
5090
5113
|
"namespace_access": {
|
|
5091
5114
|
"$ref": "#/components/schemas/schemaNamespaceAccessType"
|
|
@@ -5099,9 +5122,10 @@
|
|
|
5099
5122
|
"title": "UUID of the record.",
|
|
5100
5123
|
"x-displayname": "UUID",
|
|
5101
5124
|
"x-ves-example": "Fa45979f-4e41-4f4b-8b0b-c3ab844ab0aa.",
|
|
5125
|
+
"x-f5xc-example": "fa45979f-4e41-4f4b-8b0b-c3ab844ab0aa",
|
|
5102
5126
|
"minLength": 0,
|
|
5103
5127
|
"maxLength": 36,
|
|
5104
|
-
"x-
|
|
5128
|
+
"x-f5xc-required-for": {
|
|
5105
5129
|
"minimum_config": false,
|
|
5106
5130
|
"create": false,
|
|
5107
5131
|
"update": false,
|
|
@@ -5111,7 +5135,7 @@
|
|
|
5111
5135
|
"x-original-maxLength": 1024,
|
|
5112
5136
|
"format": "uuid",
|
|
5113
5137
|
"x-reconciled-from-discovery": true,
|
|
5114
|
-
"x-reconciled-at": "2026-01-
|
|
5138
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431868+00:00"
|
|
5115
5139
|
},
|
|
5116
5140
|
"user_email": {
|
|
5117
5141
|
"type": "string",
|
|
@@ -5119,9 +5143,10 @@
|
|
|
5119
5143
|
"title": "Email of user.",
|
|
5120
5144
|
"x-displayname": "User",
|
|
5121
5145
|
"x-ves-example": "Admin@example-corp.com.",
|
|
5146
|
+
"x-f5xc-example": "admin@example-corp.com",
|
|
5122
5147
|
"minLength": 0,
|
|
5123
5148
|
"maxLength": 1024,
|
|
5124
|
-
"x-
|
|
5149
|
+
"x-f5xc-required-for": {
|
|
5125
5150
|
"minimum_config": false,
|
|
5126
5151
|
"create": false,
|
|
5127
5152
|
"update": false,
|
|
@@ -5137,7 +5162,8 @@
|
|
|
5137
5162
|
},
|
|
5138
5163
|
"x-displayname": "User Groups.",
|
|
5139
5164
|
"x-ves-example": "[\"dev-group-1\"]",
|
|
5140
|
-
"x-
|
|
5165
|
+
"x-f5xc-example": "\"[\"dev-group-1\"]\"",
|
|
5166
|
+
"x-f5xc-required-for": {
|
|
5141
5167
|
"minimum_config": false,
|
|
5142
5168
|
"create": false,
|
|
5143
5169
|
"update": false,
|
|
@@ -5145,7 +5171,7 @@
|
|
|
5145
5171
|
}
|
|
5146
5172
|
}
|
|
5147
5173
|
},
|
|
5148
|
-
"x-
|
|
5174
|
+
"x-f5xc-minimum-configuration": {
|
|
5149
5175
|
"description": "Minimum configuration for api_credentialListServiceCredentialsResponseItem",
|
|
5150
5176
|
"required_fields": [
|
|
5151
5177
|
"active",
|
|
@@ -5164,7 +5190,7 @@
|
|
|
5164
5190
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"active\": \"value\",\n \"create_timestamp\": \"value\",\n \"expiry_timestamp\": \"value\",\n \"name\": \"value\",\n \"namespace\": \"value\"\n }\n}",
|
|
5165
5191
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_list_service_credentials_response_items\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5166
5192
|
},
|
|
5167
|
-
"x-
|
|
5193
|
+
"x-f5xc-cli-domain": "api"
|
|
5168
5194
|
},
|
|
5169
5195
|
"api_credentialNameSelector": {
|
|
5170
5196
|
"type": "object",
|
|
@@ -5196,11 +5222,7 @@
|
|
|
5196
5222
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
5197
5223
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
5198
5224
|
},
|
|
5199
|
-
"
|
|
5200
|
-
"ves.io.schema.rules.repeated.max_items": "200",
|
|
5201
|
-
"ves.io.schema.rules.repeated.min_items": "1",
|
|
5202
|
-
"ves.io.schema.rules.repeated.unique": "true",
|
|
5203
|
-
"x-ves-required-for": {
|
|
5225
|
+
"x-f5xc-required-for": {
|
|
5204
5226
|
"minimum_config": false,
|
|
5205
5227
|
"create": false,
|
|
5206
5228
|
"update": false,
|
|
@@ -5208,7 +5230,7 @@
|
|
|
5208
5230
|
}
|
|
5209
5231
|
}
|
|
5210
5232
|
},
|
|
5211
|
-
"x-
|
|
5233
|
+
"x-f5xc-minimum-configuration": {
|
|
5212
5234
|
"description": "Minimum configuration for api_credentialNameSelector",
|
|
5213
5235
|
"required_fields": [
|
|
5214
5236
|
"names"
|
|
@@ -5218,7 +5240,7 @@
|
|
|
5218
5240
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"names\": \"value\"\n }\n}",
|
|
5219
5241
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_name_selectors\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5220
5242
|
},
|
|
5221
|
-
"x-
|
|
5243
|
+
"x-f5xc-cli-domain": "api"
|
|
5222
5244
|
},
|
|
5223
5245
|
"api_credentialObject": {
|
|
5224
5246
|
"type": "object",
|
|
@@ -5237,7 +5259,7 @@
|
|
|
5237
5259
|
"$ref": "#/components/schemas/schemaSystemObjectMetaType"
|
|
5238
5260
|
}
|
|
5239
5261
|
},
|
|
5240
|
-
"x-
|
|
5262
|
+
"x-f5xc-minimum-configuration": {
|
|
5241
5263
|
"description": "Minimum configuration for api_credentialObject",
|
|
5242
5264
|
"required_fields": [
|
|
5243
5265
|
"metadata",
|
|
@@ -5249,7 +5271,7 @@
|
|
|
5249
5271
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"spec\": \"value\",\n \"system_metadata\": \"value\"\n }\n}",
|
|
5250
5272
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_objects\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5251
5273
|
},
|
|
5252
|
-
"x-
|
|
5274
|
+
"x-f5xc-cli-domain": "api"
|
|
5253
5275
|
},
|
|
5254
5276
|
"api_credentialRecreateScimTokenRequest": {
|
|
5255
5277
|
"type": "object",
|
|
@@ -5269,15 +5291,14 @@
|
|
|
5269
5291
|
"ves.io.schema.rules.uint32.gte": "1",
|
|
5270
5292
|
"ves.io.schema.rules.uint32.lte": "730"
|
|
5271
5293
|
},
|
|
5294
|
+
"x-f5xc-example": "value",
|
|
5272
5295
|
"x-validation-rules": {
|
|
5273
5296
|
"ves.io.schema.rules.uint32.gte": "1",
|
|
5274
5297
|
"ves.io.schema.rules.uint32.lte": "730"
|
|
5275
5298
|
},
|
|
5276
5299
|
"minimum": 0,
|
|
5277
5300
|
"maximum": 2147483647,
|
|
5278
|
-
"
|
|
5279
|
-
"ves.io.schema.rules.uint32.lte": "730",
|
|
5280
|
-
"x-ves-required-for": {
|
|
5301
|
+
"x-f5xc-required-for": {
|
|
5281
5302
|
"minimum_config": false,
|
|
5282
5303
|
"create": false,
|
|
5283
5304
|
"update": false,
|
|
@@ -5290,9 +5311,10 @@
|
|
|
5290
5311
|
"title": "Namespace",
|
|
5291
5312
|
"x-displayname": "Namespace",
|
|
5292
5313
|
"x-ves-example": "Value",
|
|
5314
|
+
"x-f5xc-example": "value",
|
|
5293
5315
|
"minLength": 0,
|
|
5294
5316
|
"maxLength": 6,
|
|
5295
|
-
"x-
|
|
5317
|
+
"x-f5xc-required-for": {
|
|
5296
5318
|
"minimum_config": false,
|
|
5297
5319
|
"create": false,
|
|
5298
5320
|
"update": false,
|
|
@@ -5300,10 +5322,10 @@
|
|
|
5300
5322
|
},
|
|
5301
5323
|
"x-original-maxLength": 1024,
|
|
5302
5324
|
"x-reconciled-from-discovery": true,
|
|
5303
|
-
"x-reconciled-at": "2026-01-
|
|
5325
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431883+00:00"
|
|
5304
5326
|
}
|
|
5305
5327
|
},
|
|
5306
|
-
"x-
|
|
5328
|
+
"x-f5xc-minimum-configuration": {
|
|
5307
5329
|
"description": "Minimum configuration for api_credentialRecreateScimTokenRequest",
|
|
5308
5330
|
"required_fields": [
|
|
5309
5331
|
"expiration_days",
|
|
@@ -5314,7 +5336,7 @@
|
|
|
5314
5336
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"expiration_days\": \"value\",\n \"namespace\": \"value\"\n }\n}",
|
|
5315
5337
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_recreate_scim_token_requests\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5316
5338
|
},
|
|
5317
|
-
"x-
|
|
5339
|
+
"x-f5xc-cli-domain": "api"
|
|
5318
5340
|
},
|
|
5319
5341
|
"api_credentialRenewRequest": {
|
|
5320
5342
|
"type": "object",
|
|
@@ -5330,9 +5352,10 @@
|
|
|
5330
5352
|
"format": "int64",
|
|
5331
5353
|
"x-displayname": "Expiry in days.",
|
|
5332
5354
|
"x-ves-example": "Value",
|
|
5355
|
+
"x-f5xc-example": "value",
|
|
5333
5356
|
"minimum": 0,
|
|
5334
5357
|
"maximum": 2147483647,
|
|
5335
|
-
"x-
|
|
5358
|
+
"x-f5xc-required-for": {
|
|
5336
5359
|
"minimum_config": false,
|
|
5337
5360
|
"create": false,
|
|
5338
5361
|
"update": false,
|
|
@@ -5349,13 +5372,13 @@
|
|
|
5349
5372
|
"x-ves-validation-rules": {
|
|
5350
5373
|
"ves.io.schema.rules.message.required": "true"
|
|
5351
5374
|
},
|
|
5375
|
+
"x-f5xc-example": "api-cred-73c7cbd9-1342-4ce0-97a5-6c515c0b147a",
|
|
5352
5376
|
"x-validation-rules": {
|
|
5353
5377
|
"ves.io.schema.rules.message.required": "true"
|
|
5354
5378
|
},
|
|
5355
5379
|
"minLength": 0,
|
|
5356
5380
|
"maxLength": 16,
|
|
5357
|
-
"
|
|
5358
|
-
"x-ves-required-for": {
|
|
5381
|
+
"x-f5xc-required-for": {
|
|
5359
5382
|
"minimum_config": false,
|
|
5360
5383
|
"create": false,
|
|
5361
5384
|
"update": false,
|
|
@@ -5363,7 +5386,7 @@
|
|
|
5363
5386
|
},
|
|
5364
5387
|
"x-original-maxLength": 1024,
|
|
5365
5388
|
"x-reconciled-from-discovery": true,
|
|
5366
|
-
"x-reconciled-at": "2026-01-
|
|
5389
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431889+00:00"
|
|
5367
5390
|
},
|
|
5368
5391
|
"namespace": {
|
|
5369
5392
|
"type": "string",
|
|
@@ -5375,13 +5398,13 @@
|
|
|
5375
5398
|
"x-ves-validation-rules": {
|
|
5376
5399
|
"ves.io.schema.rules.message.required": "true"
|
|
5377
5400
|
},
|
|
5401
|
+
"x-f5xc-example": "system",
|
|
5378
5402
|
"x-validation-rules": {
|
|
5379
5403
|
"ves.io.schema.rules.message.required": "true"
|
|
5380
5404
|
},
|
|
5381
5405
|
"minLength": 0,
|
|
5382
5406
|
"maxLength": 6,
|
|
5383
|
-
"
|
|
5384
|
-
"x-ves-required-for": {
|
|
5407
|
+
"x-f5xc-required-for": {
|
|
5385
5408
|
"minimum_config": false,
|
|
5386
5409
|
"create": false,
|
|
5387
5410
|
"update": false,
|
|
@@ -5389,10 +5412,10 @@
|
|
|
5389
5412
|
},
|
|
5390
5413
|
"x-original-maxLength": 1024,
|
|
5391
5414
|
"x-reconciled-from-discovery": true,
|
|
5392
|
-
"x-reconciled-at": "2026-01-
|
|
5415
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431893+00:00"
|
|
5393
5416
|
}
|
|
5394
5417
|
},
|
|
5395
|
-
"x-
|
|
5418
|
+
"x-f5xc-minimum-configuration": {
|
|
5396
5419
|
"description": "Minimum configuration for api_credentialRenewRequest",
|
|
5397
5420
|
"required_fields": [
|
|
5398
5421
|
"expiration_days",
|
|
@@ -5404,7 +5427,7 @@
|
|
|
5404
5427
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"expiration_days\": \"value\",\n \"name\": \"value\",\n \"namespace\": \"value\"\n }\n}",
|
|
5405
5428
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_renew_requests\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5406
5429
|
},
|
|
5407
|
-
"x-
|
|
5430
|
+
"x-f5xc-cli-domain": "api"
|
|
5408
5431
|
},
|
|
5409
5432
|
"api_credentialReplaceServiceCredentialsRequest": {
|
|
5410
5433
|
"type": "object",
|
|
@@ -5423,13 +5446,13 @@
|
|
|
5423
5446
|
"x-ves-validation-rules": {
|
|
5424
5447
|
"ves.io.schema.rules.message.required": "true"
|
|
5425
5448
|
},
|
|
5449
|
+
"x-f5xc-example": "api-cred-73c7cbd9-1342-4ce0-97a5-6c515c0b147a",
|
|
5426
5450
|
"x-validation-rules": {
|
|
5427
5451
|
"ves.io.schema.rules.message.required": "true"
|
|
5428
5452
|
},
|
|
5429
5453
|
"minLength": 0,
|
|
5430
5454
|
"maxLength": 16,
|
|
5431
|
-
"
|
|
5432
|
-
"x-ves-required-for": {
|
|
5455
|
+
"x-f5xc-required-for": {
|
|
5433
5456
|
"minimum_config": false,
|
|
5434
5457
|
"create": false,
|
|
5435
5458
|
"update": false,
|
|
@@ -5437,7 +5460,7 @@
|
|
|
5437
5460
|
},
|
|
5438
5461
|
"x-original-maxLength": 1024,
|
|
5439
5462
|
"x-reconciled-from-discovery": true,
|
|
5440
|
-
"x-reconciled-at": "2026-01-
|
|
5463
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431898+00:00"
|
|
5441
5464
|
},
|
|
5442
5465
|
"namespace": {
|
|
5443
5466
|
"type": "string",
|
|
@@ -5445,9 +5468,10 @@
|
|
|
5445
5468
|
"title": "Namespace",
|
|
5446
5469
|
"x-displayname": "Namespace",
|
|
5447
5470
|
"x-ves-example": "System",
|
|
5471
|
+
"x-f5xc-example": "system",
|
|
5448
5472
|
"minLength": 0,
|
|
5449
5473
|
"maxLength": 6,
|
|
5450
|
-
"x-
|
|
5474
|
+
"x-f5xc-required-for": {
|
|
5451
5475
|
"minimum_config": false,
|
|
5452
5476
|
"create": false,
|
|
5453
5477
|
"update": false,
|
|
@@ -5455,7 +5479,7 @@
|
|
|
5455
5479
|
},
|
|
5456
5480
|
"x-original-maxLength": 1024,
|
|
5457
5481
|
"x-reconciled-from-discovery": true,
|
|
5458
|
-
"x-reconciled-at": "2026-01-
|
|
5482
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431902+00:00"
|
|
5459
5483
|
},
|
|
5460
5484
|
"namespace_access": {
|
|
5461
5485
|
"$ref": "#/components/schemas/schemaNamespaceAccessType"
|
|
@@ -5469,7 +5493,8 @@
|
|
|
5469
5493
|
},
|
|
5470
5494
|
"x-displayname": "Groups",
|
|
5471
5495
|
"x-ves-example": "[\"dev-group-1\"]",
|
|
5472
|
-
"x-
|
|
5496
|
+
"x-f5xc-example": "\"[\"dev-group-1\"]\"",
|
|
5497
|
+
"x-f5xc-required-for": {
|
|
5473
5498
|
"minimum_config": false,
|
|
5474
5499
|
"create": false,
|
|
5475
5500
|
"update": false,
|
|
@@ -5477,7 +5502,7 @@
|
|
|
5477
5502
|
}
|
|
5478
5503
|
}
|
|
5479
5504
|
},
|
|
5480
|
-
"x-
|
|
5505
|
+
"x-f5xc-minimum-configuration": {
|
|
5481
5506
|
"description": "Minimum configuration for api_credentialReplaceServiceCredentialsRequest",
|
|
5482
5507
|
"required_fields": [
|
|
5483
5508
|
"name",
|
|
@@ -5490,7 +5515,7 @@
|
|
|
5490
5515
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"name\": \"value\",\n \"namespace\": \"value\",\n \"namespace_access\": \"value\",\n \"user_group_names\": \"value\"\n }\n}",
|
|
5491
5516
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_replace_service_credentials_requests\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5492
5517
|
},
|
|
5493
|
-
"x-
|
|
5518
|
+
"x-f5xc-cli-domain": "api"
|
|
5494
5519
|
},
|
|
5495
5520
|
"api_credentialReplaceServiceCredentialsResponse": {
|
|
5496
5521
|
"type": "object",
|
|
@@ -5506,7 +5531,8 @@
|
|
|
5506
5531
|
"format": "boolean",
|
|
5507
5532
|
"x-displayname": "Active",
|
|
5508
5533
|
"x-ves-example": "True",
|
|
5509
|
-
"x-
|
|
5534
|
+
"x-f5xc-example": "true",
|
|
5535
|
+
"x-f5xc-required-for": {
|
|
5510
5536
|
"minimum_config": false,
|
|
5511
5537
|
"create": false,
|
|
5512
5538
|
"update": false,
|
|
@@ -5521,7 +5547,7 @@
|
|
|
5521
5547
|
"x-displayname": "Expiry",
|
|
5522
5548
|
"minLength": 0,
|
|
5523
5549
|
"maxLength": 1024,
|
|
5524
|
-
"x-
|
|
5550
|
+
"x-f5xc-required-for": {
|
|
5525
5551
|
"minimum_config": false,
|
|
5526
5552
|
"create": false,
|
|
5527
5553
|
"update": false,
|
|
@@ -5534,9 +5560,10 @@
|
|
|
5534
5560
|
"title": "Name",
|
|
5535
5561
|
"x-displayname": "Name",
|
|
5536
5562
|
"x-ves-example": "Svc-cred-app1.",
|
|
5563
|
+
"x-f5xc-example": "svc-cred-app1",
|
|
5537
5564
|
"minLength": 0,
|
|
5538
5565
|
"maxLength": 16,
|
|
5539
|
-
"x-
|
|
5566
|
+
"x-f5xc-required-for": {
|
|
5540
5567
|
"minimum_config": false,
|
|
5541
5568
|
"create": false,
|
|
5542
5569
|
"update": false,
|
|
@@ -5544,10 +5571,10 @@
|
|
|
5544
5571
|
},
|
|
5545
5572
|
"x-original-maxLength": 1024,
|
|
5546
5573
|
"x-reconciled-from-discovery": true,
|
|
5547
|
-
"x-reconciled-at": "2026-01-
|
|
5574
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431912+00:00"
|
|
5548
5575
|
}
|
|
5549
5576
|
},
|
|
5550
|
-
"x-
|
|
5577
|
+
"x-f5xc-minimum-configuration": {
|
|
5551
5578
|
"description": "Minimum configuration for api_credentialReplaceServiceCredentialsResponse",
|
|
5552
5579
|
"required_fields": [
|
|
5553
5580
|
"active",
|
|
@@ -5559,7 +5586,7 @@
|
|
|
5559
5586
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"active\": \"value\",\n \"expiration_timestamp\": \"value\",\n \"name\": \"value\"\n }\n}",
|
|
5560
5587
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_replace_service_credentials_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5561
5588
|
},
|
|
5562
|
-
"x-
|
|
5589
|
+
"x-f5xc-cli-domain": "api"
|
|
5563
5590
|
},
|
|
5564
5591
|
"api_credentialScimTokenRequest": {
|
|
5565
5592
|
"type": "object",
|
|
@@ -5578,13 +5605,13 @@
|
|
|
5578
5605
|
"x-ves-validation-rules": {
|
|
5579
5606
|
"ves.io.schema.rules.message.required": "true"
|
|
5580
5607
|
},
|
|
5608
|
+
"x-f5xc-example": "system",
|
|
5581
5609
|
"x-validation-rules": {
|
|
5582
5610
|
"ves.io.schema.rules.message.required": "true"
|
|
5583
5611
|
},
|
|
5584
5612
|
"minLength": 0,
|
|
5585
5613
|
"maxLength": 6,
|
|
5586
|
-
"
|
|
5587
|
-
"x-ves-required-for": {
|
|
5614
|
+
"x-f5xc-required-for": {
|
|
5588
5615
|
"minimum_config": false,
|
|
5589
5616
|
"create": false,
|
|
5590
5617
|
"update": false,
|
|
@@ -5592,10 +5619,10 @@
|
|
|
5592
5619
|
},
|
|
5593
5620
|
"x-original-maxLength": 1024,
|
|
5594
5621
|
"x-reconciled-from-discovery": true,
|
|
5595
|
-
"x-reconciled-at": "2026-01-
|
|
5622
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431916+00:00"
|
|
5596
5623
|
}
|
|
5597
5624
|
},
|
|
5598
|
-
"x-
|
|
5625
|
+
"x-f5xc-minimum-configuration": {
|
|
5599
5626
|
"description": "Minimum configuration for api_credentialScimTokenRequest",
|
|
5600
5627
|
"required_fields": [
|
|
5601
5628
|
"namespace"
|
|
@@ -5605,7 +5632,7 @@
|
|
|
5605
5632
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"namespace\": \"value\"\n }\n}",
|
|
5606
5633
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_scim_token_requests\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5607
5634
|
},
|
|
5608
|
-
"x-
|
|
5635
|
+
"x-f5xc-cli-domain": "api"
|
|
5609
5636
|
},
|
|
5610
5637
|
"api_credentialSiteKubeconfigType": {
|
|
5611
5638
|
"type": "object",
|
|
@@ -5628,15 +5655,13 @@
|
|
|
5628
5655
|
"ves.io.schema.rules.string.max_bytes": "64",
|
|
5629
5656
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
5630
5657
|
},
|
|
5658
|
+
"x-f5xc-example": "ce398",
|
|
5631
5659
|
"x-validation-rules": {
|
|
5632
5660
|
"ves.io.schema.rules.message.required": "true",
|
|
5633
5661
|
"ves.io.schema.rules.string.max_bytes": "64",
|
|
5634
5662
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
5635
5663
|
},
|
|
5636
|
-
"
|
|
5637
|
-
"ves.io.schema.rules.string.max_bytes": "64",
|
|
5638
|
-
"ves.io.schema.rules.string.min_bytes": "1",
|
|
5639
|
-
"x-ves-required-for": {
|
|
5664
|
+
"x-f5xc-required-for": {
|
|
5640
5665
|
"minimum_config": false,
|
|
5641
5666
|
"create": false,
|
|
5642
5667
|
"update": false,
|
|
@@ -5644,7 +5669,7 @@
|
|
|
5644
5669
|
}
|
|
5645
5670
|
}
|
|
5646
5671
|
},
|
|
5647
|
-
"x-
|
|
5672
|
+
"x-f5xc-minimum-configuration": {
|
|
5648
5673
|
"description": "Minimum configuration for api_credentialSiteKubeconfigType",
|
|
5649
5674
|
"required_fields": [
|
|
5650
5675
|
"site"
|
|
@@ -5654,7 +5679,7 @@
|
|
|
5654
5679
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"site\": \"value\"\n }\n}",
|
|
5655
5680
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_site_kubeconfig_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5656
5681
|
},
|
|
5657
|
-
"x-
|
|
5682
|
+
"x-f5xc-cli-domain": "api"
|
|
5658
5683
|
},
|
|
5659
5684
|
"api_credentialSpecType": {
|
|
5660
5685
|
"type": "object",
|
|
@@ -5667,7 +5692,7 @@
|
|
|
5667
5692
|
"$ref": "#/components/schemas/api_credentialGlobalSpecType"
|
|
5668
5693
|
}
|
|
5669
5694
|
},
|
|
5670
|
-
"x-
|
|
5695
|
+
"x-f5xc-minimum-configuration": {
|
|
5671
5696
|
"description": "Minimum configuration for api_credentialSpecType",
|
|
5672
5697
|
"required_fields": [
|
|
5673
5698
|
"gc_spec"
|
|
@@ -5677,7 +5702,7 @@
|
|
|
5677
5702
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"gc_spec\": \"value\"\n }\n}",
|
|
5678
5703
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_spec_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5679
5704
|
},
|
|
5680
|
-
"x-
|
|
5705
|
+
"x-f5xc-cli-domain": "api"
|
|
5681
5706
|
},
|
|
5682
5707
|
"api_credentialStatusResponse": {
|
|
5683
5708
|
"type": "object",
|
|
@@ -5693,7 +5718,8 @@
|
|
|
5693
5718
|
"format": "boolean",
|
|
5694
5719
|
"x-displayname": "Status",
|
|
5695
5720
|
"x-ves-example": "True",
|
|
5696
|
-
"x-
|
|
5721
|
+
"x-f5xc-example": "true",
|
|
5722
|
+
"x-f5xc-required-for": {
|
|
5697
5723
|
"minimum_config": false,
|
|
5698
5724
|
"create": false,
|
|
5699
5725
|
"update": false,
|
|
@@ -5702,10 +5728,10 @@
|
|
|
5702
5728
|
"maxLength": 17,
|
|
5703
5729
|
"minLength": 17,
|
|
5704
5730
|
"x-reconciled-from-discovery": true,
|
|
5705
|
-
"x-reconciled-at": "2026-01-
|
|
5731
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431926+00:00"
|
|
5706
5732
|
}
|
|
5707
5733
|
},
|
|
5708
|
-
"x-
|
|
5734
|
+
"x-f5xc-minimum-configuration": {
|
|
5709
5735
|
"description": "Minimum configuration for api_credentialStatusResponse",
|
|
5710
5736
|
"required_fields": [
|
|
5711
5737
|
"status"
|
|
@@ -5715,7 +5741,7 @@
|
|
|
5715
5741
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"status\": \"value\"\n }\n}",
|
|
5716
5742
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_status_responses\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5717
5743
|
},
|
|
5718
|
-
"x-
|
|
5744
|
+
"x-f5xc-cli-domain": "api"
|
|
5719
5745
|
},
|
|
5720
5746
|
"api_credentialVk8sKubeconfigType": {
|
|
5721
5747
|
"type": "object",
|
|
@@ -5733,13 +5759,13 @@
|
|
|
5733
5759
|
"x-ves-validation-rules": {
|
|
5734
5760
|
"ves.io.schema.rules.string.ves_object_name": "true"
|
|
5735
5761
|
},
|
|
5762
|
+
"x-f5xc-example": "vk8s-product-app1",
|
|
5736
5763
|
"x-validation-rules": {
|
|
5737
5764
|
"ves.io.schema.rules.string.ves_object_name": "true"
|
|
5738
5765
|
},
|
|
5739
5766
|
"minLength": 0,
|
|
5740
5767
|
"maxLength": 1024,
|
|
5741
|
-
"
|
|
5742
|
-
"x-ves-required-for": {
|
|
5768
|
+
"x-f5xc-required-for": {
|
|
5743
5769
|
"minimum_config": false,
|
|
5744
5770
|
"create": false,
|
|
5745
5771
|
"update": false,
|
|
@@ -5755,13 +5781,13 @@
|
|
|
5755
5781
|
"x-ves-validation-rules": {
|
|
5756
5782
|
"ves.io.schema.rules.string.ves_object_name": "true"
|
|
5757
5783
|
},
|
|
5784
|
+
"x-f5xc-example": "app-ns1",
|
|
5758
5785
|
"x-validation-rules": {
|
|
5759
5786
|
"ves.io.schema.rules.string.ves_object_name": "true"
|
|
5760
5787
|
},
|
|
5761
5788
|
"minLength": 0,
|
|
5762
5789
|
"maxLength": 1024,
|
|
5763
|
-
"
|
|
5764
|
-
"x-ves-required-for": {
|
|
5790
|
+
"x-f5xc-required-for": {
|
|
5765
5791
|
"minimum_config": false,
|
|
5766
5792
|
"create": false,
|
|
5767
5793
|
"update": false,
|
|
@@ -5769,7 +5795,7 @@
|
|
|
5769
5795
|
}
|
|
5770
5796
|
}
|
|
5771
5797
|
},
|
|
5772
|
-
"x-
|
|
5798
|
+
"x-f5xc-minimum-configuration": {
|
|
5773
5799
|
"description": "Minimum configuration for api_credentialVk8sKubeconfigType",
|
|
5774
5800
|
"required_fields": [
|
|
5775
5801
|
"vk8s_cluster_name",
|
|
@@ -5780,7 +5806,7 @@
|
|
|
5780
5806
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"vk8s_cluster_name\": \"value\",\n \"vk8s_namespace\": \"value\"\n }\n}",
|
|
5781
5807
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/api_credential_vk8s_kubeconfig_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5782
5808
|
},
|
|
5783
|
-
"x-
|
|
5809
|
+
"x-f5xc-cli-domain": "api"
|
|
5784
5810
|
},
|
|
5785
5811
|
"schemaEmpty": {
|
|
5786
5812
|
"type": "object",
|
|
@@ -5788,7 +5814,7 @@
|
|
|
5788
5814
|
"title": "Empty",
|
|
5789
5815
|
"x-displayname": "Empty",
|
|
5790
5816
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
5791
|
-
"x-
|
|
5817
|
+
"x-f5xc-minimum-configuration": {
|
|
5792
5818
|
"description": "Minimum configuration for schemaEmpty",
|
|
5793
5819
|
"required_fields": [],
|
|
5794
5820
|
"mutually_exclusive_groups": [],
|
|
@@ -5796,7 +5822,7 @@
|
|
|
5796
5822
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n }\n}",
|
|
5797
5823
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/schema_empties\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5798
5824
|
},
|
|
5799
|
-
"x-
|
|
5825
|
+
"x-f5xc-cli-domain": "other"
|
|
5800
5826
|
},
|
|
5801
5827
|
"schemaInitializerType": {
|
|
5802
5828
|
"type": "object",
|
|
@@ -5810,10 +5836,10 @@
|
|
|
5810
5836
|
"description": "Name of the service that is responsible for initializing this object.",
|
|
5811
5837
|
"title": "Name",
|
|
5812
5838
|
"x-displayname": "Name",
|
|
5813
|
-
"x-
|
|
5839
|
+
"x-f5xc-example": "example-resource",
|
|
5814
5840
|
"minLength": 0,
|
|
5815
5841
|
"maxLength": 16,
|
|
5816
|
-
"x-
|
|
5842
|
+
"x-f5xc-required-for": {
|
|
5817
5843
|
"minimum_config": false,
|
|
5818
5844
|
"create": false,
|
|
5819
5845
|
"update": false,
|
|
@@ -5821,10 +5847,10 @@
|
|
|
5821
5847
|
},
|
|
5822
5848
|
"x-original-maxLength": 1024,
|
|
5823
5849
|
"x-reconciled-from-discovery": true,
|
|
5824
|
-
"x-reconciled-at": "2026-01-
|
|
5850
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431935+00:00"
|
|
5825
5851
|
}
|
|
5826
5852
|
},
|
|
5827
|
-
"x-
|
|
5853
|
+
"x-f5xc-minimum-configuration": {
|
|
5828
5854
|
"description": "Minimum configuration for schemaInitializerType",
|
|
5829
5855
|
"required_fields": [
|
|
5830
5856
|
"name"
|
|
@@ -5834,7 +5860,7 @@
|
|
|
5834
5860
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"name\": \"value\"\n }\n}",
|
|
5835
5861
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/schema_initializer_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5836
5862
|
},
|
|
5837
|
-
"x-
|
|
5863
|
+
"x-f5xc-cli-domain": "other"
|
|
5838
5864
|
},
|
|
5839
5865
|
"schemaInitializersType": {
|
|
5840
5866
|
"type": "object",
|
|
@@ -5851,7 +5877,7 @@
|
|
|
5851
5877
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
5852
5878
|
},
|
|
5853
5879
|
"x-displayname": "Pending",
|
|
5854
|
-
"x-
|
|
5880
|
+
"x-f5xc-required-for": {
|
|
5855
5881
|
"minimum_config": false,
|
|
5856
5882
|
"create": false,
|
|
5857
5883
|
"update": false,
|
|
@@ -5862,7 +5888,7 @@
|
|
|
5862
5888
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
5863
5889
|
}
|
|
5864
5890
|
},
|
|
5865
|
-
"x-
|
|
5891
|
+
"x-f5xc-minimum-configuration": {
|
|
5866
5892
|
"description": "Minimum configuration for schemaInitializersType",
|
|
5867
5893
|
"required_fields": [
|
|
5868
5894
|
"pending",
|
|
@@ -5873,7 +5899,7 @@
|
|
|
5873
5899
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"pending\": \"value\",\n \"result\": \"value\"\n }\n}",
|
|
5874
5900
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/schema_initializers_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5875
5901
|
},
|
|
5876
|
-
"x-
|
|
5902
|
+
"x-f5xc-cli-domain": "other"
|
|
5877
5903
|
},
|
|
5878
5904
|
"schemaNamespaceAccessType": {
|
|
5879
5905
|
"type": "object",
|
|
@@ -5892,14 +5918,12 @@
|
|
|
5892
5918
|
"ves.io.schema.rules.map.keys.string.max_len": "256",
|
|
5893
5919
|
"ves.io.schema.rules.message.required": "true"
|
|
5894
5920
|
},
|
|
5895
|
-
"x-
|
|
5921
|
+
"x-f5xc-example": "'<namespace> [<roles>]'",
|
|
5896
5922
|
"x-validation-rules": {
|
|
5897
5923
|
"ves.io.schema.rules.map.keys.string.max_len": "256",
|
|
5898
5924
|
"ves.io.schema.rules.message.required": "true"
|
|
5899
5925
|
},
|
|
5900
|
-
"
|
|
5901
|
-
"ves.io.schema.rules.message.required": "true",
|
|
5902
|
-
"x-ves-required-for": {
|
|
5926
|
+
"x-f5xc-required-for": {
|
|
5903
5927
|
"minimum_config": false,
|
|
5904
5928
|
"create": false,
|
|
5905
5929
|
"update": false,
|
|
@@ -5907,7 +5931,7 @@
|
|
|
5907
5931
|
}
|
|
5908
5932
|
}
|
|
5909
5933
|
},
|
|
5910
|
-
"x-
|
|
5934
|
+
"x-f5xc-minimum-configuration": {
|
|
5911
5935
|
"description": "Minimum configuration for schemaNamespaceAccessType",
|
|
5912
5936
|
"required_fields": [
|
|
5913
5937
|
"namespace_role_map"
|
|
@@ -5917,7 +5941,7 @@
|
|
|
5917
5941
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"namespace_role_map\": \"value\"\n }\n}",
|
|
5918
5942
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/schema_namespace_access_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5919
5943
|
},
|
|
5920
|
-
"x-
|
|
5944
|
+
"x-f5xc-cli-domain": "tenant_and_identity"
|
|
5921
5945
|
},
|
|
5922
5946
|
"schemaNamespaceRoleType": {
|
|
5923
5947
|
"type": "object",
|
|
@@ -5938,14 +5962,13 @@
|
|
|
5938
5962
|
"ves.io.schema.rules.message.required": "true",
|
|
5939
5963
|
"ves.io.schema.rules.string.max_len": "256"
|
|
5940
5964
|
},
|
|
5965
|
+
"x-f5xc-example": "ns1",
|
|
5941
5966
|
"x-validation-rules": {
|
|
5942
5967
|
"ves.io.schema.rules.message.required": "true",
|
|
5943
5968
|
"ves.io.schema.rules.string.max_len": "256"
|
|
5944
5969
|
},
|
|
5945
5970
|
"minLength": 0,
|
|
5946
|
-
"
|
|
5947
|
-
"ves.io.schema.rules.string.max_len": "256",
|
|
5948
|
-
"x-ves-required-for": {
|
|
5971
|
+
"x-f5xc-required-for": {
|
|
5949
5972
|
"minimum_config": false,
|
|
5950
5973
|
"create": false,
|
|
5951
5974
|
"update": false,
|
|
@@ -5953,7 +5976,7 @@
|
|
|
5953
5976
|
},
|
|
5954
5977
|
"x-original-maxLength": 256,
|
|
5955
5978
|
"x-reconciled-from-discovery": true,
|
|
5956
|
-
"x-reconciled-at": "2026-01-
|
|
5979
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431945+00:00"
|
|
5957
5980
|
},
|
|
5958
5981
|
"role": {
|
|
5959
5982
|
"type": "string",
|
|
@@ -5968,16 +5991,14 @@
|
|
|
5968
5991
|
"ves.io.schema.rules.string.max_len": "256",
|
|
5969
5992
|
"ves.io.schema.rules.string.ves_object_name": "true"
|
|
5970
5993
|
},
|
|
5994
|
+
"x-f5xc-example": "ves-io-monitor-role",
|
|
5971
5995
|
"x-validation-rules": {
|
|
5972
5996
|
"ves.io.schema.rules.message.required": "true",
|
|
5973
5997
|
"ves.io.schema.rules.string.max_len": "256",
|
|
5974
5998
|
"ves.io.schema.rules.string.ves_object_name": "true"
|
|
5975
5999
|
},
|
|
5976
6000
|
"minLength": 0,
|
|
5977
|
-
"
|
|
5978
|
-
"ves.io.schema.rules.string.max_len": "256",
|
|
5979
|
-
"ves.io.schema.rules.string.ves_object_name": "true",
|
|
5980
|
-
"x-ves-required-for": {
|
|
6001
|
+
"x-f5xc-required-for": {
|
|
5981
6002
|
"minimum_config": false,
|
|
5982
6003
|
"create": false,
|
|
5983
6004
|
"update": false,
|
|
@@ -5985,7 +6006,7 @@
|
|
|
5985
6006
|
}
|
|
5986
6007
|
}
|
|
5987
6008
|
},
|
|
5988
|
-
"x-
|
|
6009
|
+
"x-f5xc-minimum-configuration": {
|
|
5989
6010
|
"description": "Minimum configuration for schemaNamespaceRoleType",
|
|
5990
6011
|
"required_fields": [
|
|
5991
6012
|
"namespace",
|
|
@@ -5996,7 +6017,7 @@
|
|
|
5996
6017
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"namespace\": \"value\",\n \"role\": \"value\"\n }\n}",
|
|
5997
6018
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/schema_namespace_role_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
5998
6019
|
},
|
|
5999
|
-
"x-
|
|
6020
|
+
"x-f5xc-cli-domain": "tenant_and_identity"
|
|
6000
6021
|
},
|
|
6001
6022
|
"schemaObjectMetaType": {
|
|
6002
6023
|
"type": "object",
|
|
@@ -6017,17 +6038,14 @@
|
|
|
6017
6038
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
6018
6039
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
6019
6040
|
},
|
|
6041
|
+
"x-f5xc-example": "value",
|
|
6020
6042
|
"x-validation-rules": {
|
|
6021
6043
|
"ves.io.schema.rules.map.keys.string.max_len": "64",
|
|
6022
6044
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
6023
6045
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
6024
6046
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
6025
6047
|
},
|
|
6026
|
-
"
|
|
6027
|
-
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
6028
|
-
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
6029
|
-
"ves.io.schema.rules.map.values.string.min_len": "1",
|
|
6030
|
-
"x-ves-required-for": {
|
|
6048
|
+
"x-f5xc-required-for": {
|
|
6031
6049
|
"minimum_config": false,
|
|
6032
6050
|
"create": false,
|
|
6033
6051
|
"update": false,
|
|
@@ -6044,12 +6062,12 @@
|
|
|
6044
6062
|
"x-ves-validation-rules": {
|
|
6045
6063
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
6046
6064
|
},
|
|
6065
|
+
"x-f5xc-example": "Virtual Host for example-corp website",
|
|
6047
6066
|
"x-validation-rules": {
|
|
6048
6067
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
6049
6068
|
},
|
|
6050
6069
|
"minLength": 0,
|
|
6051
|
-
"
|
|
6052
|
-
"x-ves-required-for": {
|
|
6070
|
+
"x-f5xc-required-for": {
|
|
6053
6071
|
"minimum_config": false,
|
|
6054
6072
|
"create": false,
|
|
6055
6073
|
"update": false,
|
|
@@ -6057,7 +6075,7 @@
|
|
|
6057
6075
|
},
|
|
6058
6076
|
"x-original-maxLength": 1200,
|
|
6059
6077
|
"x-reconciled-from-discovery": true,
|
|
6060
|
-
"x-reconciled-at": "2026-01-
|
|
6078
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431954+00:00"
|
|
6061
6079
|
},
|
|
6062
6080
|
"disable": {
|
|
6063
6081
|
"type": "boolean",
|
|
@@ -6066,7 +6084,8 @@
|
|
|
6066
6084
|
"format": "boolean",
|
|
6067
6085
|
"x-displayname": "Disable",
|
|
6068
6086
|
"x-ves-example": "True",
|
|
6069
|
-
"x-
|
|
6087
|
+
"x-f5xc-example": "true",
|
|
6088
|
+
"x-f5xc-required-for": {
|
|
6070
6089
|
"minimum_config": false,
|
|
6071
6090
|
"create": false,
|
|
6072
6091
|
"update": false,
|
|
@@ -6079,7 +6098,8 @@
|
|
|
6079
6098
|
"title": "Labels",
|
|
6080
6099
|
"x-displayname": "Labels",
|
|
6081
6100
|
"x-ves-example": "Value",
|
|
6082
|
-
"x-
|
|
6101
|
+
"x-f5xc-example": "value",
|
|
6102
|
+
"x-f5xc-required-for": {
|
|
6083
6103
|
"minimum_config": false,
|
|
6084
6104
|
"create": false,
|
|
6085
6105
|
"update": false,
|
|
@@ -6096,13 +6116,13 @@
|
|
|
6096
6116
|
"x-ves-validation-rules": {
|
|
6097
6117
|
"ves.io.schema.rules.message.required": "true"
|
|
6098
6118
|
},
|
|
6119
|
+
"x-f5xc-example": "example-corp-web",
|
|
6099
6120
|
"x-validation-rules": {
|
|
6100
6121
|
"ves.io.schema.rules.message.required": "true"
|
|
6101
6122
|
},
|
|
6102
6123
|
"minLength": 0,
|
|
6103
6124
|
"maxLength": 16,
|
|
6104
|
-
"
|
|
6105
|
-
"x-ves-required-for": {
|
|
6125
|
+
"x-f5xc-required-for": {
|
|
6106
6126
|
"minimum_config": false,
|
|
6107
6127
|
"create": false,
|
|
6108
6128
|
"update": false,
|
|
@@ -6110,7 +6130,7 @@
|
|
|
6110
6130
|
},
|
|
6111
6131
|
"x-original-maxLength": 1024,
|
|
6112
6132
|
"x-reconciled-from-discovery": true,
|
|
6113
|
-
"x-reconciled-at": "2026-01-
|
|
6133
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431961+00:00"
|
|
6114
6134
|
},
|
|
6115
6135
|
"namespace": {
|
|
6116
6136
|
"type": "string",
|
|
@@ -6118,9 +6138,10 @@
|
|
|
6118
6138
|
"title": "Namespace",
|
|
6119
6139
|
"x-displayname": "Namespace",
|
|
6120
6140
|
"x-ves-example": "Staging",
|
|
6141
|
+
"x-f5xc-example": "staging",
|
|
6121
6142
|
"minLength": 0,
|
|
6122
6143
|
"maxLength": 6,
|
|
6123
|
-
"x-
|
|
6144
|
+
"x-f5xc-required-for": {
|
|
6124
6145
|
"minimum_config": false,
|
|
6125
6146
|
"create": false,
|
|
6126
6147
|
"update": false,
|
|
@@ -6128,7 +6149,7 @@
|
|
|
6128
6149
|
},
|
|
6129
6150
|
"x-original-maxLength": 1024,
|
|
6130
6151
|
"x-reconciled-from-discovery": true,
|
|
6131
|
-
"x-reconciled-at": "2026-01-
|
|
6152
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431965+00:00"
|
|
6132
6153
|
},
|
|
6133
6154
|
"uid": {
|
|
6134
6155
|
"type": "string",
|
|
@@ -6136,9 +6157,10 @@
|
|
|
6136
6157
|
"title": "Uid",
|
|
6137
6158
|
"x-displayname": "UID",
|
|
6138
6159
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
6160
|
+
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
6139
6161
|
"minLength": 0,
|
|
6140
6162
|
"maxLength": 36,
|
|
6141
|
-
"x-
|
|
6163
|
+
"x-f5xc-required-for": {
|
|
6142
6164
|
"minimum_config": false,
|
|
6143
6165
|
"create": false,
|
|
6144
6166
|
"update": false,
|
|
@@ -6149,10 +6171,10 @@
|
|
|
6149
6171
|
"x-original-maxLength": 1024,
|
|
6150
6172
|
"format": "uuid",
|
|
6151
6173
|
"x-reconciled-from-discovery": true,
|
|
6152
|
-
"x-reconciled-at": "2026-01-
|
|
6174
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431971+00:00"
|
|
6153
6175
|
}
|
|
6154
6176
|
},
|
|
6155
|
-
"x-
|
|
6177
|
+
"x-f5xc-minimum-configuration": {
|
|
6156
6178
|
"description": "Minimum configuration for schemaObjectMetaType",
|
|
6157
6179
|
"required_fields": [
|
|
6158
6180
|
"annotations",
|
|
@@ -6168,7 +6190,7 @@
|
|
|
6168
6190
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"annotations\": \"value\",\n \"description\": \"value\",\n \"disable\": \"value\",\n \"labels\": \"value\",\n \"name\": \"value\"\n }\n}",
|
|
6169
6191
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/schema_object_meta_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
6170
6192
|
},
|
|
6171
|
-
"x-
|
|
6193
|
+
"x-f5xc-cli-domain": "other"
|
|
6172
6194
|
},
|
|
6173
6195
|
"schemaObjectRefType": {
|
|
6174
6196
|
"type": "object",
|
|
@@ -6183,9 +6205,10 @@
|
|
|
6183
6205
|
"title": "Kind",
|
|
6184
6206
|
"x-displayname": "Kind",
|
|
6185
6207
|
"x-ves-example": "Virtual_site.",
|
|
6208
|
+
"x-f5xc-example": "virtual_site",
|
|
6186
6209
|
"minLength": 0,
|
|
6187
6210
|
"maxLength": 14,
|
|
6188
|
-
"x-
|
|
6211
|
+
"x-f5xc-required-for": {
|
|
6189
6212
|
"minimum_config": false,
|
|
6190
6213
|
"create": false,
|
|
6191
6214
|
"update": false,
|
|
@@ -6194,7 +6217,7 @@
|
|
|
6194
6217
|
"readOnly": true,
|
|
6195
6218
|
"x-original-maxLength": 1024,
|
|
6196
6219
|
"x-reconciled-from-discovery": true,
|
|
6197
|
-
"x-reconciled-at": "2026-01-
|
|
6220
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431975+00:00"
|
|
6198
6221
|
},
|
|
6199
6222
|
"name": {
|
|
6200
6223
|
"type": "string",
|
|
@@ -6202,9 +6225,10 @@
|
|
|
6202
6225
|
"title": "Name",
|
|
6203
6226
|
"x-displayname": "Name",
|
|
6204
6227
|
"x-ves-example": "Contactus-route.",
|
|
6228
|
+
"x-f5xc-example": "contactus-route",
|
|
6205
6229
|
"minLength": 0,
|
|
6206
6230
|
"maxLength": 16,
|
|
6207
|
-
"x-
|
|
6231
|
+
"x-f5xc-required-for": {
|
|
6208
6232
|
"minimum_config": false,
|
|
6209
6233
|
"create": false,
|
|
6210
6234
|
"update": false,
|
|
@@ -6212,7 +6236,7 @@
|
|
|
6212
6236
|
},
|
|
6213
6237
|
"x-original-maxLength": 1024,
|
|
6214
6238
|
"x-reconciled-from-discovery": true,
|
|
6215
|
-
"x-reconciled-at": "2026-01-
|
|
6239
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431979+00:00"
|
|
6216
6240
|
},
|
|
6217
6241
|
"namespace": {
|
|
6218
6242
|
"type": "string",
|
|
@@ -6220,9 +6244,10 @@
|
|
|
6220
6244
|
"title": "Namespace",
|
|
6221
6245
|
"x-displayname": "Namespace",
|
|
6222
6246
|
"x-ves-example": "Ns1",
|
|
6247
|
+
"x-f5xc-example": "ns1",
|
|
6223
6248
|
"minLength": 0,
|
|
6224
6249
|
"maxLength": 6,
|
|
6225
|
-
"x-
|
|
6250
|
+
"x-f5xc-required-for": {
|
|
6226
6251
|
"minimum_config": false,
|
|
6227
6252
|
"create": false,
|
|
6228
6253
|
"update": false,
|
|
@@ -6230,7 +6255,7 @@
|
|
|
6230
6255
|
},
|
|
6231
6256
|
"x-original-maxLength": 1024,
|
|
6232
6257
|
"x-reconciled-from-discovery": true,
|
|
6233
|
-
"x-reconciled-at": "2026-01-
|
|
6258
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431983+00:00"
|
|
6234
6259
|
},
|
|
6235
6260
|
"tenant": {
|
|
6236
6261
|
"type": "string",
|
|
@@ -6238,9 +6263,10 @@
|
|
|
6238
6263
|
"title": "Tenant",
|
|
6239
6264
|
"x-displayname": "Tenant",
|
|
6240
6265
|
"x-ves-example": "Example-corp.",
|
|
6266
|
+
"x-f5xc-example": "example-corp",
|
|
6241
6267
|
"minLength": 0,
|
|
6242
6268
|
"maxLength": 18,
|
|
6243
|
-
"x-
|
|
6269
|
+
"x-f5xc-required-for": {
|
|
6244
6270
|
"minimum_config": false,
|
|
6245
6271
|
"create": false,
|
|
6246
6272
|
"update": false,
|
|
@@ -6250,7 +6276,7 @@
|
|
|
6250
6276
|
"x-field-mutability": "read-only",
|
|
6251
6277
|
"x-original-maxLength": 1024,
|
|
6252
6278
|
"x-reconciled-from-discovery": true,
|
|
6253
|
-
"x-reconciled-at": "2026-01-
|
|
6279
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431987+00:00"
|
|
6254
6280
|
},
|
|
6255
6281
|
"uid": {
|
|
6256
6282
|
"type": "string",
|
|
@@ -6258,9 +6284,10 @@
|
|
|
6258
6284
|
"title": "Uid",
|
|
6259
6285
|
"x-displayname": "UID",
|
|
6260
6286
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
6287
|
+
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
6261
6288
|
"minLength": 0,
|
|
6262
6289
|
"maxLength": 36,
|
|
6263
|
-
"x-
|
|
6290
|
+
"x-f5xc-required-for": {
|
|
6264
6291
|
"minimum_config": false,
|
|
6265
6292
|
"create": false,
|
|
6266
6293
|
"update": false,
|
|
@@ -6271,10 +6298,10 @@
|
|
|
6271
6298
|
"x-original-maxLength": 1024,
|
|
6272
6299
|
"format": "uuid",
|
|
6273
6300
|
"x-reconciled-from-discovery": true,
|
|
6274
|
-
"x-reconciled-at": "2026-01-
|
|
6301
|
+
"x-reconciled-at": "2026-01-04T19:54:25.431991+00:00"
|
|
6275
6302
|
}
|
|
6276
6303
|
},
|
|
6277
|
-
"x-
|
|
6304
|
+
"x-f5xc-minimum-configuration": {
|
|
6278
6305
|
"description": "Minimum configuration for schemaObjectRefType",
|
|
6279
6306
|
"required_fields": [
|
|
6280
6307
|
"kind",
|
|
@@ -6288,7 +6315,7 @@
|
|
|
6288
6315
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"name\": \"value\",\n \"namespace\": \"value\",\n \"tenant\": \"value\",\n \"uid\": \"value\"\n }\n}",
|
|
6289
6316
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/schema_object_ref_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
6290
6317
|
},
|
|
6291
|
-
"x-
|
|
6318
|
+
"x-f5xc-cli-domain": "other"
|
|
6292
6319
|
},
|
|
6293
6320
|
"schemaRoleListType": {
|
|
6294
6321
|
"type": "object",
|
|
@@ -6302,7 +6329,7 @@
|
|
|
6302
6329
|
"items": {
|
|
6303
6330
|
"type": "string"
|
|
6304
6331
|
},
|
|
6305
|
-
"x-
|
|
6332
|
+
"x-f5xc-required-for": {
|
|
6306
6333
|
"minimum_config": false,
|
|
6307
6334
|
"create": false,
|
|
6308
6335
|
"update": false,
|
|
@@ -6310,7 +6337,7 @@
|
|
|
6310
6337
|
}
|
|
6311
6338
|
}
|
|
6312
6339
|
},
|
|
6313
|
-
"x-
|
|
6340
|
+
"x-f5xc-minimum-configuration": {
|
|
6314
6341
|
"description": "Minimum configuration for schemaRoleListType",
|
|
6315
6342
|
"required_fields": [
|
|
6316
6343
|
"names"
|
|
@@ -6320,7 +6347,7 @@
|
|
|
6320
6347
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"names\": \"value\"\n }\n}",
|
|
6321
6348
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/schema_role_list_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
6322
6349
|
},
|
|
6323
|
-
"x-
|
|
6350
|
+
"x-f5xc-cli-domain": "tenant_and_identity"
|
|
6324
6351
|
},
|
|
6325
6352
|
"schemaStatusType": {
|
|
6326
6353
|
"type": "object",
|
|
@@ -6336,9 +6363,10 @@
|
|
|
6336
6363
|
"format": "int32",
|
|
6337
6364
|
"x-displayname": "Code",
|
|
6338
6365
|
"x-ves-example": "0",
|
|
6366
|
+
"x-f5xc-example": "0",
|
|
6339
6367
|
"minimum": 0,
|
|
6340
6368
|
"maximum": 2147483647,
|
|
6341
|
-
"x-
|
|
6369
|
+
"x-f5xc-required-for": {
|
|
6342
6370
|
"minimum_config": false,
|
|
6343
6371
|
"create": false,
|
|
6344
6372
|
"update": false,
|
|
@@ -6351,9 +6379,10 @@
|
|
|
6351
6379
|
"title": "Reason",
|
|
6352
6380
|
"x-displayname": "Reason",
|
|
6353
6381
|
"x-ves-example": "Value",
|
|
6382
|
+
"x-f5xc-example": "value",
|
|
6354
6383
|
"minLength": 0,
|
|
6355
6384
|
"maxLength": 43,
|
|
6356
|
-
"x-
|
|
6385
|
+
"x-f5xc-required-for": {
|
|
6357
6386
|
"minimum_config": false,
|
|
6358
6387
|
"create": false,
|
|
6359
6388
|
"update": false,
|
|
@@ -6361,7 +6390,7 @@
|
|
|
6361
6390
|
},
|
|
6362
6391
|
"x-original-maxLength": 1024,
|
|
6363
6392
|
"x-reconciled-from-discovery": true,
|
|
6364
|
-
"x-reconciled-at": "2026-01-
|
|
6393
|
+
"x-reconciled-at": "2026-01-04T19:54:25.432000+00:00"
|
|
6365
6394
|
},
|
|
6366
6395
|
"status": {
|
|
6367
6396
|
"type": "string",
|
|
@@ -6369,9 +6398,10 @@
|
|
|
6369
6398
|
"title": "Status",
|
|
6370
6399
|
"x-displayname": "Status",
|
|
6371
6400
|
"x-ves-example": "Value",
|
|
6401
|
+
"x-f5xc-example": "value",
|
|
6372
6402
|
"minLength": 0,
|
|
6373
6403
|
"maxLength": 17,
|
|
6374
|
-
"x-
|
|
6404
|
+
"x-f5xc-required-for": {
|
|
6375
6405
|
"minimum_config": false,
|
|
6376
6406
|
"create": false,
|
|
6377
6407
|
"update": false,
|
|
@@ -6379,10 +6409,10 @@
|
|
|
6379
6409
|
},
|
|
6380
6410
|
"x-original-maxLength": 1024,
|
|
6381
6411
|
"x-reconciled-from-discovery": true,
|
|
6382
|
-
"x-reconciled-at": "2026-01-
|
|
6412
|
+
"x-reconciled-at": "2026-01-04T19:54:25.432004+00:00"
|
|
6383
6413
|
}
|
|
6384
6414
|
},
|
|
6385
|
-
"x-
|
|
6415
|
+
"x-f5xc-minimum-configuration": {
|
|
6386
6416
|
"description": "Minimum configuration for schemaStatusType",
|
|
6387
6417
|
"required_fields": [
|
|
6388
6418
|
"code",
|
|
@@ -6394,7 +6424,7 @@
|
|
|
6394
6424
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"code\": \"value\",\n \"reason\": \"value\",\n \"status\": \"value\"\n }\n}",
|
|
6395
6425
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/schema_status_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
6396
6426
|
},
|
|
6397
|
-
"x-
|
|
6427
|
+
"x-f5xc-cli-domain": "other"
|
|
6398
6428
|
},
|
|
6399
6429
|
"schemaSystemObjectMetaType": {
|
|
6400
6430
|
"type": "object",
|
|
@@ -6411,7 +6441,7 @@
|
|
|
6411
6441
|
"x-displayname": "Creation Timestamp.",
|
|
6412
6442
|
"minLength": 0,
|
|
6413
6443
|
"maxLength": 1024,
|
|
6414
|
-
"x-
|
|
6444
|
+
"x-f5xc-required-for": {
|
|
6415
6445
|
"minimum_config": false,
|
|
6416
6446
|
"create": false,
|
|
6417
6447
|
"update": false,
|
|
@@ -6426,9 +6456,10 @@
|
|
|
6426
6456
|
"title": "Creator_class.",
|
|
6427
6457
|
"x-displayname": "Creator Class.",
|
|
6428
6458
|
"x-ves-example": "Value",
|
|
6459
|
+
"x-f5xc-example": "value",
|
|
6429
6460
|
"minLength": 0,
|
|
6430
6461
|
"maxLength": 1024,
|
|
6431
|
-
"x-
|
|
6462
|
+
"x-f5xc-required-for": {
|
|
6432
6463
|
"minimum_config": false,
|
|
6433
6464
|
"create": false,
|
|
6434
6465
|
"update": false,
|
|
@@ -6443,9 +6474,10 @@
|
|
|
6443
6474
|
"title": "Creator_cookie.",
|
|
6444
6475
|
"x-displayname": "Creator Cookie.",
|
|
6445
6476
|
"x-ves-example": "Value",
|
|
6477
|
+
"x-f5xc-example": "value",
|
|
6446
6478
|
"minLength": 0,
|
|
6447
6479
|
"maxLength": 1024,
|
|
6448
|
-
"x-
|
|
6480
|
+
"x-f5xc-required-for": {
|
|
6449
6481
|
"minimum_config": false,
|
|
6450
6482
|
"create": false,
|
|
6451
6483
|
"update": false,
|
|
@@ -6459,9 +6491,10 @@
|
|
|
6459
6491
|
"title": "Creator_id.",
|
|
6460
6492
|
"x-displayname": "Creator ID.",
|
|
6461
6493
|
"x-ves-example": "Value",
|
|
6494
|
+
"x-f5xc-example": "value",
|
|
6462
6495
|
"minLength": 0,
|
|
6463
6496
|
"maxLength": 1024,
|
|
6464
|
-
"x-
|
|
6497
|
+
"x-f5xc-required-for": {
|
|
6465
6498
|
"minimum_config": false,
|
|
6466
6499
|
"create": false,
|
|
6467
6500
|
"update": false,
|
|
@@ -6478,7 +6511,7 @@
|
|
|
6478
6511
|
"x-displayname": "Deletion Timestamp.",
|
|
6479
6512
|
"minLength": 0,
|
|
6480
6513
|
"maxLength": 1024,
|
|
6481
|
-
"x-
|
|
6514
|
+
"x-f5xc-required-for": {
|
|
6482
6515
|
"minimum_config": false,
|
|
6483
6516
|
"create": false,
|
|
6484
6517
|
"update": false,
|
|
@@ -6492,7 +6525,7 @@
|
|
|
6492
6525
|
"x-displayname": "Direct Reference Hash.",
|
|
6493
6526
|
"minLength": 0,
|
|
6494
6527
|
"maxLength": 1024,
|
|
6495
|
-
"x-
|
|
6528
|
+
"x-f5xc-required-for": {
|
|
6496
6529
|
"minimum_config": false,
|
|
6497
6530
|
"create": false,
|
|
6498
6531
|
"update": false,
|
|
@@ -6508,7 +6541,8 @@
|
|
|
6508
6541
|
},
|
|
6509
6542
|
"x-displayname": "Finalizers.",
|
|
6510
6543
|
"x-ves-example": "Value",
|
|
6511
|
-
"x-
|
|
6544
|
+
"x-f5xc-example": "value",
|
|
6545
|
+
"x-f5xc-required-for": {
|
|
6512
6546
|
"minimum_config": false,
|
|
6513
6547
|
"create": false,
|
|
6514
6548
|
"update": false,
|
|
@@ -6524,7 +6558,8 @@
|
|
|
6524
6558
|
"title": "Labels",
|
|
6525
6559
|
"x-displayname": "Labels",
|
|
6526
6560
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
6527
|
-
"x-
|
|
6561
|
+
"x-f5xc-example": "'F5 XC/soft-deleted''true'",
|
|
6562
|
+
"x-f5xc-required-for": {
|
|
6528
6563
|
"minimum_config": false,
|
|
6529
6564
|
"create": false,
|
|
6530
6565
|
"update": false,
|
|
@@ -6539,7 +6574,7 @@
|
|
|
6539
6574
|
"x-displayname": "Modification Timestamp.",
|
|
6540
6575
|
"minLength": 0,
|
|
6541
6576
|
"maxLength": 1024,
|
|
6542
|
-
"x-
|
|
6577
|
+
"x-f5xc-required-for": {
|
|
6543
6578
|
"minimum_config": false,
|
|
6544
6579
|
"create": false,
|
|
6545
6580
|
"update": false,
|
|
@@ -6563,8 +6598,7 @@
|
|
|
6563
6598
|
"x-validation-rules": {
|
|
6564
6599
|
"ves.io.schema.rules.repeated.max_items": "1"
|
|
6565
6600
|
},
|
|
6566
|
-
"
|
|
6567
|
-
"x-ves-required-for": {
|
|
6601
|
+
"x-f5xc-required-for": {
|
|
6568
6602
|
"minimum_config": false,
|
|
6569
6603
|
"create": false,
|
|
6570
6604
|
"update": false,
|
|
@@ -6573,7 +6607,7 @@
|
|
|
6573
6607
|
"maxLength": 6,
|
|
6574
6608
|
"minLength": 6,
|
|
6575
6609
|
"x-reconciled-from-discovery": true,
|
|
6576
|
-
"x-reconciled-at": "2026-01-
|
|
6610
|
+
"x-reconciled-at": "2026-01-04T19:54:25.432023+00:00"
|
|
6577
6611
|
},
|
|
6578
6612
|
"object_index": {
|
|
6579
6613
|
"type": "integer",
|
|
@@ -6582,9 +6616,10 @@
|
|
|
6582
6616
|
"format": "int64",
|
|
6583
6617
|
"x-displayname": "Object Index.",
|
|
6584
6618
|
"x-ves-example": "0",
|
|
6619
|
+
"x-f5xc-example": "0",
|
|
6585
6620
|
"minimum": 0,
|
|
6586
6621
|
"maximum": 2147483647,
|
|
6587
|
-
"x-
|
|
6622
|
+
"x-f5xc-required-for": {
|
|
6588
6623
|
"minimum_config": false,
|
|
6589
6624
|
"create": false,
|
|
6590
6625
|
"update": false,
|
|
@@ -6604,7 +6639,7 @@
|
|
|
6604
6639
|
"x-displayname": "Revision",
|
|
6605
6640
|
"minLength": 0,
|
|
6606
6641
|
"maxLength": 1024,
|
|
6607
|
-
"x-
|
|
6642
|
+
"x-f5xc-required-for": {
|
|
6608
6643
|
"minimum_config": false,
|
|
6609
6644
|
"create": false,
|
|
6610
6645
|
"update": false,
|
|
@@ -6618,7 +6653,8 @@
|
|
|
6618
6653
|
"format": "boolean",
|
|
6619
6654
|
"x-displayname": "SRE Disable.",
|
|
6620
6655
|
"x-ves-example": "True",
|
|
6621
|
-
"x-
|
|
6656
|
+
"x-f5xc-example": "true",
|
|
6657
|
+
"x-f5xc-required-for": {
|
|
6622
6658
|
"minimum_config": false,
|
|
6623
6659
|
"create": false,
|
|
6624
6660
|
"update": false,
|
|
@@ -6631,9 +6667,10 @@
|
|
|
6631
6667
|
"title": "Tenant",
|
|
6632
6668
|
"x-displayname": "Tenant",
|
|
6633
6669
|
"x-ves-example": "Example-corp.",
|
|
6670
|
+
"x-f5xc-example": "example-corp",
|
|
6634
6671
|
"minLength": 0,
|
|
6635
6672
|
"maxLength": 18,
|
|
6636
|
-
"x-
|
|
6673
|
+
"x-f5xc-required-for": {
|
|
6637
6674
|
"minimum_config": false,
|
|
6638
6675
|
"create": false,
|
|
6639
6676
|
"update": false,
|
|
@@ -6643,7 +6680,7 @@
|
|
|
6643
6680
|
"x-field-mutability": "read-only",
|
|
6644
6681
|
"x-original-maxLength": 1024,
|
|
6645
6682
|
"x-reconciled-from-discovery": true,
|
|
6646
|
-
"x-reconciled-at": "2026-01-
|
|
6683
|
+
"x-reconciled-at": "2026-01-04T19:54:25.432033+00:00"
|
|
6647
6684
|
},
|
|
6648
6685
|
"trace_info": {
|
|
6649
6686
|
"type": "string",
|
|
@@ -6651,9 +6688,10 @@
|
|
|
6651
6688
|
"title": "Trace_info.",
|
|
6652
6689
|
"x-displayname": "Trace Info.",
|
|
6653
6690
|
"x-ves-example": "Value",
|
|
6691
|
+
"x-f5xc-example": "value",
|
|
6654
6692
|
"minLength": 0,
|
|
6655
6693
|
"maxLength": 1024,
|
|
6656
|
-
"x-
|
|
6694
|
+
"x-f5xc-required-for": {
|
|
6657
6695
|
"minimum_config": false,
|
|
6658
6696
|
"create": false,
|
|
6659
6697
|
"update": false,
|
|
@@ -6666,9 +6704,10 @@
|
|
|
6666
6704
|
"title": "Uid",
|
|
6667
6705
|
"x-displayname": "UID",
|
|
6668
6706
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
6707
|
+
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
6669
6708
|
"minLength": 0,
|
|
6670
6709
|
"maxLength": 36,
|
|
6671
|
-
"x-
|
|
6710
|
+
"x-f5xc-required-for": {
|
|
6672
6711
|
"minimum_config": false,
|
|
6673
6712
|
"create": false,
|
|
6674
6713
|
"update": false,
|
|
@@ -6679,7 +6718,7 @@
|
|
|
6679
6718
|
"x-original-maxLength": 1024,
|
|
6680
6719
|
"format": "uuid",
|
|
6681
6720
|
"x-reconciled-from-discovery": true,
|
|
6682
|
-
"x-reconciled-at": "2026-01-
|
|
6721
|
+
"x-reconciled-at": "2026-01-04T19:54:25.432039+00:00"
|
|
6683
6722
|
},
|
|
6684
6723
|
"vtrp_id": {
|
|
6685
6724
|
"type": "string",
|
|
@@ -6688,7 +6727,7 @@
|
|
|
6688
6727
|
"x-displayname": "VTRP ID",
|
|
6689
6728
|
"minLength": 0,
|
|
6690
6729
|
"maxLength": 1024,
|
|
6691
|
-
"x-
|
|
6730
|
+
"x-f5xc-required-for": {
|
|
6692
6731
|
"minimum_config": false,
|
|
6693
6732
|
"create": false,
|
|
6694
6733
|
"update": false,
|
|
@@ -6702,7 +6741,7 @@
|
|
|
6702
6741
|
"title": "Vtrp_stale.",
|
|
6703
6742
|
"format": "boolean",
|
|
6704
6743
|
"x-displayname": "VTRP Stale.",
|
|
6705
|
-
"x-
|
|
6744
|
+
"x-f5xc-required-for": {
|
|
6706
6745
|
"minimum_config": false,
|
|
6707
6746
|
"create": false,
|
|
6708
6747
|
"update": false,
|
|
@@ -6710,7 +6749,7 @@
|
|
|
6710
6749
|
}
|
|
6711
6750
|
}
|
|
6712
6751
|
},
|
|
6713
|
-
"x-
|
|
6752
|
+
"x-f5xc-minimum-configuration": {
|
|
6714
6753
|
"description": "Minimum configuration for schemaSystemObjectMetaType",
|
|
6715
6754
|
"required_fields": [
|
|
6716
6755
|
"creation_timestamp",
|
|
@@ -6739,7 +6778,7 @@
|
|
|
6739
6778
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"creation_timestamp\": \"value\",\n \"creator_class\": \"value\",\n \"creator_cookie\": \"value\",\n \"creator_id\": \"value\",\n \"deletion_timestamp\": \"value\"\n }\n}",
|
|
6740
6779
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/schema_system_object_meta_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
6741
6780
|
},
|
|
6742
|
-
"x-
|
|
6781
|
+
"x-f5xc-cli-domain": "other"
|
|
6743
6782
|
},
|
|
6744
6783
|
"schemaViewRefType": {
|
|
6745
6784
|
"type": "object",
|
|
@@ -6754,9 +6793,10 @@
|
|
|
6754
6793
|
"title": "Kind",
|
|
6755
6794
|
"x-displayname": "Kind",
|
|
6756
6795
|
"x-ves-example": "Http_proxy.",
|
|
6796
|
+
"x-f5xc-example": "http_proxy",
|
|
6757
6797
|
"minLength": 0,
|
|
6758
6798
|
"maxLength": 14,
|
|
6759
|
-
"x-
|
|
6799
|
+
"x-f5xc-required-for": {
|
|
6760
6800
|
"minimum_config": false,
|
|
6761
6801
|
"create": false,
|
|
6762
6802
|
"update": false,
|
|
@@ -6764,7 +6804,7 @@
|
|
|
6764
6804
|
},
|
|
6765
6805
|
"x-original-maxLength": 1024,
|
|
6766
6806
|
"x-reconciled-from-discovery": true,
|
|
6767
|
-
"x-reconciled-at": "2026-01-
|
|
6807
|
+
"x-reconciled-at": "2026-01-04T19:54:25.432046+00:00"
|
|
6768
6808
|
},
|
|
6769
6809
|
"name": {
|
|
6770
6810
|
"type": "string",
|
|
@@ -6772,9 +6812,10 @@
|
|
|
6772
6812
|
"title": "Name",
|
|
6773
6813
|
"x-displayname": "Name",
|
|
6774
6814
|
"x-ves-example": "Contactus-route.",
|
|
6815
|
+
"x-f5xc-example": "contactus-route",
|
|
6775
6816
|
"minLength": 0,
|
|
6776
6817
|
"maxLength": 16,
|
|
6777
|
-
"x-
|
|
6818
|
+
"x-f5xc-required-for": {
|
|
6778
6819
|
"minimum_config": false,
|
|
6779
6820
|
"create": false,
|
|
6780
6821
|
"update": false,
|
|
@@ -6782,7 +6823,7 @@
|
|
|
6782
6823
|
},
|
|
6783
6824
|
"x-original-maxLength": 1024,
|
|
6784
6825
|
"x-reconciled-from-discovery": true,
|
|
6785
|
-
"x-reconciled-at": "2026-01-
|
|
6826
|
+
"x-reconciled-at": "2026-01-04T19:54:25.432050+00:00"
|
|
6786
6827
|
},
|
|
6787
6828
|
"namespace": {
|
|
6788
6829
|
"type": "string",
|
|
@@ -6790,9 +6831,10 @@
|
|
|
6790
6831
|
"title": "Namespace",
|
|
6791
6832
|
"x-displayname": "Namespace",
|
|
6792
6833
|
"x-ves-example": "Ns1",
|
|
6834
|
+
"x-f5xc-example": "ns1",
|
|
6793
6835
|
"minLength": 0,
|
|
6794
6836
|
"maxLength": 6,
|
|
6795
|
-
"x-
|
|
6837
|
+
"x-f5xc-required-for": {
|
|
6796
6838
|
"minimum_config": false,
|
|
6797
6839
|
"create": false,
|
|
6798
6840
|
"update": false,
|
|
@@ -6800,7 +6842,7 @@
|
|
|
6800
6842
|
},
|
|
6801
6843
|
"x-original-maxLength": 1024,
|
|
6802
6844
|
"x-reconciled-from-discovery": true,
|
|
6803
|
-
"x-reconciled-at": "2026-01-
|
|
6845
|
+
"x-reconciled-at": "2026-01-04T19:54:25.432054+00:00"
|
|
6804
6846
|
},
|
|
6805
6847
|
"uid": {
|
|
6806
6848
|
"type": "string",
|
|
@@ -6808,9 +6850,10 @@
|
|
|
6808
6850
|
"title": "Uid",
|
|
6809
6851
|
"x-displayname": "UID",
|
|
6810
6852
|
"x-ves-example": "F3744323-1adf-4aaa-a5dc-0707c1d1bd82.",
|
|
6853
|
+
"x-f5xc-example": "f3744323-1adf-4aaa-a5dc-0707c1d1bd82",
|
|
6811
6854
|
"minLength": 0,
|
|
6812
6855
|
"maxLength": 36,
|
|
6813
|
-
"x-
|
|
6856
|
+
"x-f5xc-required-for": {
|
|
6814
6857
|
"minimum_config": false,
|
|
6815
6858
|
"create": false,
|
|
6816
6859
|
"update": false,
|
|
@@ -6820,10 +6863,10 @@
|
|
|
6820
6863
|
"x-original-maxLength": 1024,
|
|
6821
6864
|
"format": "uuid",
|
|
6822
6865
|
"x-reconciled-from-discovery": true,
|
|
6823
|
-
"x-reconciled-at": "2026-01-
|
|
6866
|
+
"x-reconciled-at": "2026-01-04T19:54:25.432058+00:00"
|
|
6824
6867
|
}
|
|
6825
6868
|
},
|
|
6826
|
-
"x-
|
|
6869
|
+
"x-f5xc-minimum-configuration": {
|
|
6827
6870
|
"description": "Minimum configuration for schemaViewRefType",
|
|
6828
6871
|
"required_fields": [
|
|
6829
6872
|
"kind",
|
|
@@ -6836,7 +6879,7 @@
|
|
|
6836
6879
|
"example_json": "{\n \"metadata\": {\n \"name\": \"example\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"name\": \"value\",\n \"namespace\": \"value\",\n \"uid\": \"value\"\n }\n}",
|
|
6837
6880
|
"example_curl": "curl -X POST \"$F5XC_API_URL/api/config/namespaces/default/schema_view_ref_types\" \\\n -H \"Authorization: APIToken $F5XC_API_TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d @example.json"
|
|
6838
6881
|
},
|
|
6839
|
-
"x-
|
|
6882
|
+
"x-f5xc-cli-domain": "other"
|
|
6840
6883
|
}
|
|
6841
6884
|
},
|
|
6842
6885
|
"responses": {},
|