@robinmordasiewicz/f5xc-api-mcp 3.4.0 → 3.5.0

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.
Files changed (150) hide show
  1. package/dist/generator/openapi-parser.d.ts +14 -77
  2. package/dist/generator/openapi-parser.d.ts.map +1 -1
  3. package/dist/generator/openapi-parser.js +85 -17
  4. package/dist/generator/openapi-parser.js.map +1 -1
  5. package/dist/generator/tool-generator.d.ts +2 -3
  6. package/dist/generator/tool-generator.d.ts.map +1 -1
  7. package/dist/generator/tool-generator.js +1 -28
  8. package/dist/generator/tool-generator.js.map +1 -1
  9. package/dist/index.d.ts +2 -10
  10. package/dist/index.d.ts.map +1 -1
  11. package/dist/index.js +28 -33
  12. package/dist/index.js.map +1 -1
  13. package/dist/prompts/workflows.d.ts.map +1 -1
  14. package/dist/prompts/workflows.js +30 -174
  15. package/dist/prompts/workflows.js.map +1 -1
  16. package/dist/resources/handlers.d.ts +0 -2
  17. package/dist/resources/handlers.d.ts.map +1 -1
  18. package/dist/resources/handlers.js +0 -51
  19. package/dist/resources/handlers.js.map +1 -1
  20. package/dist/server.d.ts +1 -1
  21. package/dist/server.d.ts.map +1 -1
  22. package/dist/server.js +1 -2
  23. package/dist/server.js.map +1 -1
  24. package/dist/tools/discovery/execute.d.ts +1 -3
  25. package/dist/tools/discovery/execute.d.ts.map +1 -1
  26. package/dist/tools/discovery/execute.js +1 -34
  27. package/dist/tools/discovery/execute.js.map +1 -1
  28. package/dist/tools/generated/admin_console_and_ui/index.d.ts.map +1 -1
  29. package/dist/tools/generated/admin_console_and_ui/index.js +2 -28
  30. package/dist/tools/generated/admin_console_and_ui/index.js.map +1 -1
  31. package/dist/tools/generated/api/index.d.ts.map +1 -1
  32. package/dist/tools/generated/api/index.js +52 -908
  33. package/dist/tools/generated/api/index.js.map +1 -1
  34. package/dist/tools/generated/authentication/index.d.ts.map +1 -1
  35. package/dist/tools/generated/authentication/index.js +9 -156
  36. package/dist/tools/generated/authentication/index.js.map +1 -1
  37. package/dist/tools/generated/bigip/index.d.ts.map +1 -1
  38. package/dist/tools/generated/bigip/index.js +25 -410
  39. package/dist/tools/generated/bigip/index.js.map +1 -1
  40. package/dist/tools/generated/billing_and_usage/index.d.ts.map +1 -1
  41. package/dist/tools/generated/billing_and_usage/index.js +23 -442
  42. package/dist/tools/generated/billing_and_usage/index.js.map +1 -1
  43. package/dist/tools/generated/blindfold/index.d.ts.map +1 -1
  44. package/dist/tools/generated/blindfold/index.js +32 -568
  45. package/dist/tools/generated/blindfold/index.js.map +1 -1
  46. package/dist/tools/generated/bot_and_threat_defense/index.d.ts.map +1 -1
  47. package/dist/tools/generated/bot_and_threat_defense/index.js +20 -340
  48. package/dist/tools/generated/bot_and_threat_defense/index.js.map +1 -1
  49. package/dist/tools/generated/cdn/index.d.ts.map +1 -1
  50. package/dist/tools/generated/cdn/index.js +22 -428
  51. package/dist/tools/generated/cdn/index.js.map +1 -1
  52. package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
  53. package/dist/tools/generated/ce_management/index.js +32 -558
  54. package/dist/tools/generated/ce_management/index.js.map +1 -1
  55. package/dist/tools/generated/certificates/index.d.ts.map +1 -1
  56. package/dist/tools/generated/certificates/index.js +20 -320
  57. package/dist/tools/generated/certificates/index.js.map +1 -1
  58. package/dist/tools/generated/cloud_infrastructure/index.d.ts.map +1 -1
  59. package/dist/tools/generated/cloud_infrastructure/index.js +33 -572
  60. package/dist/tools/generated/cloud_infrastructure/index.js.map +1 -1
  61. package/dist/tools/generated/container_services/index.d.ts.map +1 -1
  62. package/dist/tools/generated/container_services/index.js +16 -264
  63. package/dist/tools/generated/container_services/index.js.map +1 -1
  64. package/dist/tools/generated/data_and_privacy_security/index.d.ts.map +1 -1
  65. package/dist/tools/generated/data_and_privacy_security/index.js +13 -202
  66. package/dist/tools/generated/data_and_privacy_security/index.js.map +1 -1
  67. package/dist/tools/generated/data_intelligence/index.d.ts.map +1 -1
  68. package/dist/tools/generated/data_intelligence/index.js +15 -290
  69. package/dist/tools/generated/data_intelligence/index.js.map +1 -1
  70. package/dist/tools/generated/ddos/index.d.ts.map +1 -1
  71. package/dist/tools/generated/ddos/index.js +68 -1152
  72. package/dist/tools/generated/ddos/index.js.map +1 -1
  73. package/dist/tools/generated/dns/index.d.ts.map +1 -1
  74. package/dist/tools/generated/dns/index.js +52 -908
  75. package/dist/tools/generated/dns/index.js.map +1 -1
  76. package/dist/tools/generated/generative_ai/index.d.ts.map +1 -1
  77. package/dist/tools/generated/generative_ai/index.js +11 -254
  78. package/dist/tools/generated/generative_ai/index.js.map +1 -1
  79. package/dist/tools/generated/managed_kubernetes/index.d.ts.map +1 -1
  80. package/dist/tools/generated/managed_kubernetes/index.js +25 -400
  81. package/dist/tools/generated/managed_kubernetes/index.js.map +1 -1
  82. package/dist/tools/generated/marketplace/index.d.ts.map +1 -1
  83. package/dist/tools/generated/marketplace/index.js +36 -594
  84. package/dist/tools/generated/marketplace/index.js.map +1 -1
  85. package/dist/tools/generated/network/index.d.ts.map +1 -1
  86. package/dist/tools/generated/network/index.js +98 -1582
  87. package/dist/tools/generated/network/index.js.map +1 -1
  88. package/dist/tools/generated/network_security/index.d.ts.map +1 -1
  89. package/dist/tools/generated/network_security/index.js +69 -1126
  90. package/dist/tools/generated/network_security/index.js.map +1 -1
  91. package/dist/tools/generated/nginx_one/index.d.ts.map +1 -1
  92. package/dist/tools/generated/nginx_one/index.js +14 -236
  93. package/dist/tools/generated/nginx_one/index.js.map +1 -1
  94. package/dist/tools/generated/object_storage/index.d.ts.map +1 -1
  95. package/dist/tools/generated/object_storage/index.js +7 -98
  96. package/dist/tools/generated/object_storage/index.js.map +1 -1
  97. package/dist/tools/generated/observability/index.d.ts.map +1 -1
  98. package/dist/tools/generated/observability/index.js +45 -790
  99. package/dist/tools/generated/observability/index.js.map +1 -1
  100. package/dist/tools/generated/rate_limiting/index.d.ts.map +1 -1
  101. package/dist/tools/generated/rate_limiting/index.js +15 -240
  102. package/dist/tools/generated/rate_limiting/index.js.map +1 -1
  103. package/dist/tools/generated/secops_and_incident_response/index.d.ts.map +1 -1
  104. package/dist/tools/generated/secops_and_incident_response/index.js +5 -80
  105. package/dist/tools/generated/secops_and_incident_response/index.js.map +1 -1
  106. package/dist/tools/generated/service_mesh/index.d.ts.map +1 -1
  107. package/dist/tools/generated/service_mesh/index.js +44 -766
  108. package/dist/tools/generated/service_mesh/index.js.map +1 -1
  109. package/dist/tools/generated/shape/index.d.ts.map +1 -1
  110. package/dist/tools/generated/shape/index.js +182 -3502
  111. package/dist/tools/generated/shape/index.js.map +1 -1
  112. package/dist/tools/generated/sites/index.d.ts.map +1 -1
  113. package/dist/tools/generated/sites/index.js +106 -1864
  114. package/dist/tools/generated/sites/index.js.map +1 -1
  115. package/dist/tools/generated/statistics/index.d.ts.map +1 -1
  116. package/dist/tools/generated/statistics/index.js +70 -1350
  117. package/dist/tools/generated/statistics/index.js.map +1 -1
  118. package/dist/tools/generated/support/index.d.ts.map +1 -1
  119. package/dist/tools/generated/support/index.js +47 -928
  120. package/dist/tools/generated/support/index.js.map +1 -1
  121. package/dist/tools/generated/telemetry_and_insights/index.d.ts.map +1 -1
  122. package/dist/tools/generated/telemetry_and_insights/index.js +23 -492
  123. package/dist/tools/generated/telemetry_and_insights/index.js.map +1 -1
  124. package/dist/tools/generated/tenant_and_identity/index.d.ts.map +1 -1
  125. package/dist/tools/generated/tenant_and_identity/index.js +185 -3081
  126. package/dist/tools/generated/tenant_and_identity/index.js.map +1 -1
  127. package/dist/tools/generated/threat_campaign/index.d.ts.map +1 -1
  128. package/dist/tools/generated/threat_campaign/index.js +1 -14
  129. package/dist/tools/generated/threat_campaign/index.js.map +1 -1
  130. package/dist/tools/generated/users/index.d.ts.map +1 -1
  131. package/dist/tools/generated/users/index.js +12 -208
  132. package/dist/tools/generated/users/index.js.map +1 -1
  133. package/dist/tools/generated/virtual/index.d.ts.map +1 -1
  134. package/dist/tools/generated/virtual/index.js +89 -1526
  135. package/dist/tools/generated/virtual/index.js.map +1 -1
  136. package/dist/tools/generated/vpm_and_node_management/index.d.ts.map +1 -1
  137. package/dist/tools/generated/vpm_and_node_management/index.js +1 -14
  138. package/dist/tools/generated/vpm_and_node_management/index.js.map +1 -1
  139. package/dist/tools/generated/waf/index.d.ts.map +1 -1
  140. package/dist/tools/generated/waf/index.js +36 -674
  141. package/dist/tools/generated/waf/index.js.map +1 -1
  142. package/package.json +1 -1
  143. package/dist/cli/index.d.ts +0 -16
  144. package/dist/cli/index.d.ts.map +0 -1
  145. package/dist/cli/index.js +0 -116
  146. package/dist/cli/index.js.map +0 -1
  147. package/dist/cli/setup.d.ts +0 -54
  148. package/dist/cli/setup.d.ts.map +0 -1
  149. package/dist/cli/setup.js +0 -347
  150. package/dist/cli/setup.js.map +0 -1
@@ -49,13 +49,6 @@ export const wafTools = [
49
49
  dangerLevel: "low",
50
50
  sideEffects: null,
51
51
  requiredFields: ["path.namespace", "path.vh_name"],
52
- cliExamples: [
53
- {
54
- command: "f5xcctl config active-staged-signature list --namespace {namespace}",
55
- description: "List all active-staged-signatures",
56
- use_case: "list_all",
57
- },
58
- ],
59
52
  confirmationRequired: false,
60
53
  parameterExamples: {
61
54
  namespace: "Shared",
@@ -101,13 +94,6 @@ export const wafTools = [
101
94
  },
102
95
  confirmation_required: false,
103
96
  danger_level: "low",
104
- examples: [
105
- {
106
- command: "f5xcctl config active-staged-signature list --namespace {namespace}",
107
- description: "List all active-staged-signatures",
108
- use_case: "list_all",
109
- },
110
- ],
111
97
  field_docs: {},
112
98
  optional_fields: [],
113
99
  performance_impact: {
@@ -118,6 +104,7 @@ export const wafTools = [
118
104
  required_fields: ["path.namespace", "path.vh_name"],
119
105
  side_effects: {},
120
106
  },
107
+ curlExample: null,
121
108
  },
122
109
  {
123
110
  toolName: "f5xc-api-waf-aggregation-create",
@@ -144,18 +131,6 @@ export const wafTools = [
144
131
  creates: ["aggregation"],
145
132
  },
146
133
  requiredFields: ["metadata.name", "metadata.namespace"],
147
- cliExamples: [
148
- {
149
- command: "f5xcctl data aggregation create {name} --namespace {namespace}",
150
- description: "Create aggregation",
151
- use_case: "basic_create",
152
- },
153
- {
154
- command: "f5xcctl data aggregation create -f {file}.yaml",
155
- description: "Create from YAML file",
156
- use_case: "file_based",
157
- },
158
- ],
159
134
  confirmationRequired: false,
160
135
  parameterExamples: {},
161
136
  validationRules: {},
@@ -198,18 +173,6 @@ export const wafTools = [
198
173
  },
199
174
  confirmation_required: false,
200
175
  danger_level: "medium",
201
- examples: [
202
- {
203
- command: "f5xcctl data aggregation create {name} --namespace {namespace}",
204
- description: "Create aggregation",
205
- use_case: "basic_create",
206
- },
207
- {
208
- command: "f5xcctl data aggregation create -f {file}.yaml",
209
- description: "Create from YAML file",
210
- use_case: "file_based",
211
- },
212
- ],
213
176
  field_docs: {},
214
177
  optional_fields: [],
215
178
  performance_impact: {
@@ -222,6 +185,7 @@ export const wafTools = [
222
185
  creates: ["aggregation"],
223
186
  },
224
187
  },
188
+ curlExample: null,
225
189
  },
226
190
  {
227
191
  toolName: "f5xc-api-waf-all-ns-event-create",
@@ -248,18 +212,6 @@ export const wafTools = [
248
212
  creates: ["all-ns-event"],
249
213
  },
250
214
  requiredFields: ["metadata.name", "metadata.namespace"],
251
- cliExamples: [
252
- {
253
- command: "f5xcctl data all-ns-event create {name} --namespace {namespace}",
254
- description: "Create all-ns-event",
255
- use_case: "basic_create",
256
- },
257
- {
258
- command: "f5xcctl data all-ns-event create -f {file}.yaml",
259
- description: "Create from YAML file",
260
- use_case: "file_based",
261
- },
262
- ],
263
215
  confirmationRequired: false,
264
216
  parameterExamples: {},
265
217
  validationRules: {},
@@ -302,18 +254,6 @@ export const wafTools = [
302
254
  },
303
255
  confirmation_required: false,
304
256
  danger_level: "medium",
305
- examples: [
306
- {
307
- command: "f5xcctl data all-ns-event create {name} --namespace {namespace}",
308
- description: "Create all-ns-event",
309
- use_case: "basic_create",
310
- },
311
- {
312
- command: "f5xcctl data all-ns-event create -f {file}.yaml",
313
- description: "Create from YAML file",
314
- use_case: "file_based",
315
- },
316
- ],
317
257
  field_docs: {},
318
258
  optional_fields: [],
319
259
  performance_impact: {
@@ -326,6 +266,7 @@ export const wafTools = [
326
266
  creates: ["all-ns-event"],
327
267
  },
328
268
  },
269
+ curlExample: null,
329
270
  },
330
271
  {
331
272
  toolName: "f5xc-api-waf-all-ns-metric-create",
@@ -352,18 +293,6 @@ export const wafTools = [
352
293
  creates: ["all-ns-metric"],
353
294
  },
354
295
  requiredFields: ["metadata.name", "metadata.namespace"],
355
- cliExamples: [
356
- {
357
- command: "f5xcctl data all-ns-metric create {name} --namespace {namespace}",
358
- description: "Create all-ns-metric",
359
- use_case: "basic_create",
360
- },
361
- {
362
- command: "f5xcctl data all-ns-metric create -f {file}.yaml",
363
- description: "Create from YAML file",
364
- use_case: "file_based",
365
- },
366
- ],
367
296
  confirmationRequired: false,
368
297
  parameterExamples: {},
369
298
  validationRules: {},
@@ -406,18 +335,6 @@ export const wafTools = [
406
335
  },
407
336
  confirmation_required: false,
408
337
  danger_level: "medium",
409
- examples: [
410
- {
411
- command: "f5xcctl data all-ns-metric create {name} --namespace {namespace}",
412
- description: "Create all-ns-metric",
413
- use_case: "basic_create",
414
- },
415
- {
416
- command: "f5xcctl data all-ns-metric create -f {file}.yaml",
417
- description: "Create from YAML file",
418
- use_case: "file_based",
419
- },
420
- ],
421
338
  field_docs: {},
422
339
  optional_fields: [],
423
340
  performance_impact: {
@@ -430,6 +347,7 @@ export const wafTools = [
430
347
  creates: ["all-ns-metric"],
431
348
  },
432
349
  },
350
+ curlExample: null,
433
351
  },
434
352
  {
435
353
  toolName: "f5xc-api-waf-app-firewall-create",
@@ -470,18 +388,6 @@ export const wafTools = [
470
388
  creates: ["app-firewall"],
471
389
  },
472
390
  requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
473
- cliExamples: [
474
- {
475
- command: "f5xcctl config app-firewall create {name} --namespace {namespace}",
476
- description: "Create app-firewall",
477
- use_case: "basic_create",
478
- },
479
- {
480
- command: "f5xcctl config app-firewall create -f {file}.yaml",
481
- description: "Create from YAML file",
482
- use_case: "file_based",
483
- },
484
- ],
485
391
  confirmationRequired: false,
486
392
  parameterExamples: {
487
393
  "metadata.namespace": "Staging",
@@ -526,18 +432,6 @@ export const wafTools = [
526
432
  },
527
433
  confirmation_required: false,
528
434
  danger_level: "medium",
529
- examples: [
530
- {
531
- command: "f5xcctl config app-firewall create {name} --namespace {namespace}",
532
- description: "Create app-firewall",
533
- use_case: "basic_create",
534
- },
535
- {
536
- command: "f5xcctl config app-firewall create -f {file}.yaml",
537
- description: "Create from YAML file",
538
- use_case: "file_based",
539
- },
540
- ],
541
435
  field_docs: {},
542
436
  optional_fields: [],
543
437
  performance_impact: {
@@ -550,6 +444,7 @@ export const wafTools = [
550
444
  creates: ["app-firewall"],
551
445
  },
552
446
  },
447
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/app_firewalls" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @waf-policy.json\n',
553
448
  },
554
449
  {
555
450
  toolName: "f5xc-api-waf-app-firewall-delete",
@@ -599,13 +494,6 @@ export const wafTools = [
599
494
  deletes: ["app-firewall", "contained_resources"],
600
495
  },
601
496
  requiredFields: ["path.name", "path.namespace"],
602
- cliExamples: [
603
- {
604
- command: "f5xcctl config app-firewall delete {name} --namespace {namespace}",
605
- description: "Delete app-firewall",
606
- use_case: "delete",
607
- },
608
- ],
609
497
  confirmationRequired: true,
610
498
  parameterExamples: {
611
499
  name: "Name",
@@ -651,13 +539,6 @@ export const wafTools = [
651
539
  },
652
540
  confirmation_required: true,
653
541
  danger_level: "high",
654
- examples: [
655
- {
656
- command: "f5xcctl config app-firewall delete {name} --namespace {namespace}",
657
- description: "Delete app-firewall",
658
- use_case: "delete",
659
- },
660
- ],
661
542
  field_docs: {},
662
543
  optional_fields: [],
663
544
  performance_impact: {
@@ -670,6 +551,7 @@ export const wafTools = [
670
551
  deletes: ["app-firewall", "contained_resources"],
671
552
  },
672
553
  },
554
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/app_firewalls" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @waf-policy.json\n',
673
555
  },
674
556
  {
675
557
  toolName: "f5xc-api-waf-app-firewall-get",
@@ -738,13 +620,6 @@ export const wafTools = [
738
620
  dangerLevel: "low",
739
621
  sideEffects: null,
740
622
  requiredFields: ["path.name", "path.namespace"],
741
- cliExamples: [
742
- {
743
- command: "f5xcctl config app-firewall get {name} --namespace {namespace}",
744
- description: "Get specific app-firewall",
745
- use_case: "get_specific",
746
- },
747
- ],
748
623
  confirmationRequired: false,
749
624
  parameterExamples: {
750
625
  name: "Name",
@@ -790,13 +665,6 @@ export const wafTools = [
790
665
  },
791
666
  confirmation_required: false,
792
667
  danger_level: "low",
793
- examples: [
794
- {
795
- command: "f5xcctl config app-firewall get {name} --namespace {namespace}",
796
- description: "Get specific app-firewall",
797
- use_case: "get_specific",
798
- },
799
- ],
800
668
  field_docs: {},
801
669
  optional_fields: [],
802
670
  performance_impact: {
@@ -807,6 +675,7 @@ export const wafTools = [
807
675
  required_fields: ["path.name", "path.namespace"],
808
676
  side_effects: {},
809
677
  },
678
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/app_firewalls" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @waf-policy.json\n',
810
679
  },
811
680
  {
812
681
  toolName: "f5xc-api-waf-app-firewall-list",
@@ -881,13 +750,6 @@ export const wafTools = [
881
750
  dangerLevel: "low",
882
751
  sideEffects: null,
883
752
  requiredFields: ["path.namespace"],
884
- cliExamples: [
885
- {
886
- command: "f5xcctl config app-firewall list --namespace {namespace}",
887
- description: "List all app-firewalls",
888
- use_case: "list_all",
889
- },
890
- ],
891
753
  confirmationRequired: false,
892
754
  parameterExamples: {
893
755
  label_filter: "Env in (staging, testing), tier in (web, db)",
@@ -933,13 +795,6 @@ export const wafTools = [
933
795
  },
934
796
  confirmation_required: false,
935
797
  danger_level: "low",
936
- examples: [
937
- {
938
- command: "f5xcctl config app-firewall list --namespace {namespace}",
939
- description: "List all app-firewalls",
940
- use_case: "list_all",
941
- },
942
- ],
943
798
  field_docs: {},
944
799
  optional_fields: [],
945
800
  performance_impact: {
@@ -950,6 +805,7 @@ export const wafTools = [
950
805
  required_fields: ["path.namespace"],
951
806
  side_effects: {},
952
807
  },
808
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/app_firewalls" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @waf-policy.json\n',
953
809
  },
954
810
  {
955
811
  toolName: "f5xc-api-waf-app-firewall-update",
@@ -1001,13 +857,6 @@ export const wafTools = [
1001
857
  modifies: ["app-firewall"],
1002
858
  },
1003
859
  requiredFields: ["path.metadata.name", "path.metadata.namespace"],
1004
- cliExamples: [
1005
- {
1006
- command: "f5xcctl config app-firewall update {name} --namespace {namespace} -f {file}.yaml",
1007
- description: "Update app-firewall",
1008
- use_case: "update",
1009
- },
1010
- ],
1011
860
  confirmationRequired: false,
1012
861
  parameterExamples: {
1013
862
  "metadata.name": "Example-corp-web.",
@@ -1053,13 +902,6 @@ export const wafTools = [
1053
902
  },
1054
903
  confirmation_required: false,
1055
904
  danger_level: "medium",
1056
- examples: [
1057
- {
1058
- command: "f5xcctl config app-firewall update {name} --namespace {namespace} -f {file}.yaml",
1059
- description: "Update app-firewall",
1060
- use_case: "update",
1061
- },
1062
- ],
1063
905
  field_docs: {},
1064
906
  optional_fields: [],
1065
907
  performance_impact: {
@@ -1072,6 +914,7 @@ export const wafTools = [
1072
914
  modifies: ["app-firewall"],
1073
915
  },
1074
916
  },
917
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/app_firewalls" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @waf-policy.json\n',
1075
918
  },
1076
919
  {
1077
920
  toolName: "f5xc-api-waf-enhanced-firewall-policy-create",
@@ -1112,18 +955,6 @@ export const wafTools = [
1112
955
  creates: ["enhanced-firewall-policy"],
1113
956
  },
1114
957
  requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
1115
- cliExamples: [
1116
- {
1117
- command: "f5xcctl config enhanced-firewall-policy create {name} --namespace {namespace}",
1118
- description: "Create enhanced-firewall-policy",
1119
- use_case: "basic_create",
1120
- },
1121
- {
1122
- command: "f5xcctl config enhanced-firewall-policy create -f {file}.yaml",
1123
- description: "Create from YAML file",
1124
- use_case: "file_based",
1125
- },
1126
- ],
1127
958
  confirmationRequired: false,
1128
959
  parameterExamples: {
1129
960
  "metadata.namespace": "Staging",
@@ -1171,18 +1002,6 @@ export const wafTools = [
1171
1002
  },
1172
1003
  confirmation_required: false,
1173
1004
  danger_level: "medium",
1174
- examples: [
1175
- {
1176
- command: "f5xcctl config enhanced-firewall-policy create {name} --namespace {namespace}",
1177
- description: "Create enhanced-firewall-policy",
1178
- use_case: "basic_create",
1179
- },
1180
- {
1181
- command: "f5xcctl config enhanced-firewall-policy create -f {file}.yaml",
1182
- description: "Create from YAML file",
1183
- use_case: "file_based",
1184
- },
1185
- ],
1186
1005
  field_docs: {},
1187
1006
  optional_fields: [],
1188
1007
  performance_impact: {
@@ -1195,6 +1014,7 @@ export const wafTools = [
1195
1014
  creates: ["enhanced-firewall-policy"],
1196
1015
  },
1197
1016
  },
1017
+ curlExample: null,
1198
1018
  },
1199
1019
  {
1200
1020
  toolName: "f5xc-api-waf-enhanced-firewall-policy-delete",
@@ -1244,13 +1064,6 @@ export const wafTools = [
1244
1064
  deletes: ["enhanced-firewall-policy", "contained_resources"],
1245
1065
  },
1246
1066
  requiredFields: ["path.name", "path.namespace"],
1247
- cliExamples: [
1248
- {
1249
- command: "f5xcctl config enhanced-firewall-policy delete {name} --namespace {namespace}",
1250
- description: "Delete enhanced-firewall-policy",
1251
- use_case: "delete",
1252
- },
1253
- ],
1254
1067
  confirmationRequired: true,
1255
1068
  parameterExamples: {
1256
1069
  name: "Name",
@@ -1296,13 +1109,6 @@ export const wafTools = [
1296
1109
  },
1297
1110
  confirmation_required: true,
1298
1111
  danger_level: "high",
1299
- examples: [
1300
- {
1301
- command: "f5xcctl config enhanced-firewall-policy delete {name} --namespace {namespace}",
1302
- description: "Delete enhanced-firewall-policy",
1303
- use_case: "delete",
1304
- },
1305
- ],
1306
1112
  field_docs: {},
1307
1113
  optional_fields: [],
1308
1114
  performance_impact: {
@@ -1315,6 +1121,7 @@ export const wafTools = [
1315
1121
  deletes: ["enhanced-firewall-policy", "contained_resources"],
1316
1122
  },
1317
1123
  },
1124
+ curlExample: null,
1318
1125
  },
1319
1126
  {
1320
1127
  toolName: "f5xc-api-waf-enhanced-firewall-policy-get",
@@ -1383,13 +1190,6 @@ export const wafTools = [
1383
1190
  dangerLevel: "low",
1384
1191
  sideEffects: null,
1385
1192
  requiredFields: ["path.name", "path.namespace"],
1386
- cliExamples: [
1387
- {
1388
- command: "f5xcctl config enhanced-firewall-policy get {name} --namespace {namespace}",
1389
- description: "Get specific enhanced-firewall-policy",
1390
- use_case: "get_specific",
1391
- },
1392
- ],
1393
1193
  confirmationRequired: false,
1394
1194
  parameterExamples: {
1395
1195
  name: "Name",
@@ -1435,13 +1235,6 @@ export const wafTools = [
1435
1235
  },
1436
1236
  confirmation_required: false,
1437
1237
  danger_level: "low",
1438
- examples: [
1439
- {
1440
- command: "f5xcctl config enhanced-firewall-policy get {name} --namespace {namespace}",
1441
- description: "Get specific enhanced-firewall-policy",
1442
- use_case: "get_specific",
1443
- },
1444
- ],
1445
1238
  field_docs: {},
1446
1239
  optional_fields: [],
1447
1240
  performance_impact: {
@@ -1452,6 +1245,7 @@ export const wafTools = [
1452
1245
  required_fields: ["path.name", "path.namespace"],
1453
1246
  side_effects: {},
1454
1247
  },
1248
+ curlExample: null,
1455
1249
  },
1456
1250
  {
1457
1251
  toolName: "f5xc-api-waf-enhanced-firewall-policy-list",
@@ -1526,13 +1320,6 @@ export const wafTools = [
1526
1320
  dangerLevel: "low",
1527
1321
  sideEffects: null,
1528
1322
  requiredFields: ["path.namespace"],
1529
- cliExamples: [
1530
- {
1531
- command: "f5xcctl config enhanced-firewall-policy list --namespace {namespace}",
1532
- description: "List all enhanced-firewall-policys",
1533
- use_case: "list_all",
1534
- },
1535
- ],
1536
1323
  confirmationRequired: false,
1537
1324
  parameterExamples: {
1538
1325
  label_filter: "Env in (staging, testing), tier in (web, db)",
@@ -1578,13 +1365,6 @@ export const wafTools = [
1578
1365
  },
1579
1366
  confirmation_required: false,
1580
1367
  danger_level: "low",
1581
- examples: [
1582
- {
1583
- command: "f5xcctl config enhanced-firewall-policy list --namespace {namespace}",
1584
- description: "List all enhanced-firewall-policys",
1585
- use_case: "list_all",
1586
- },
1587
- ],
1588
1368
  field_docs: {},
1589
1369
  optional_fields: [],
1590
1370
  performance_impact: {
@@ -1595,6 +1375,7 @@ export const wafTools = [
1595
1375
  required_fields: ["path.namespace"],
1596
1376
  side_effects: {},
1597
1377
  },
1378
+ curlExample: null,
1598
1379
  },
1599
1380
  {
1600
1381
  toolName: "f5xc-api-waf-enhanced-firewall-policy-update",
@@ -1646,13 +1427,6 @@ export const wafTools = [
1646
1427
  modifies: ["enhanced-firewall-policy"],
1647
1428
  },
1648
1429
  requiredFields: ["path.metadata.name", "path.metadata.namespace"],
1649
- cliExamples: [
1650
- {
1651
- command: "f5xcctl config enhanced-firewall-policy update {name} --namespace {namespace} -f {file}.yaml",
1652
- description: "Update enhanced-firewall-policy",
1653
- use_case: "update",
1654
- },
1655
- ],
1656
1430
  confirmationRequired: false,
1657
1431
  parameterExamples: {
1658
1432
  "metadata.name": "Example-corp-web.",
@@ -1698,13 +1472,6 @@ export const wafTools = [
1698
1472
  },
1699
1473
  confirmation_required: false,
1700
1474
  danger_level: "medium",
1701
- examples: [
1702
- {
1703
- command: "f5xcctl config enhanced-firewall-policy update {name} --namespace {namespace} -f {file}.yaml",
1704
- description: "Update enhanced-firewall-policy",
1705
- use_case: "update",
1706
- },
1707
- ],
1708
1475
  field_docs: {},
1709
1476
  optional_fields: [],
1710
1477
  performance_impact: {
@@ -1717,6 +1484,7 @@ export const wafTools = [
1717
1484
  modifies: ["enhanced-firewall-policy"],
1718
1485
  },
1719
1486
  },
1487
+ curlExample: null,
1720
1488
  },
1721
1489
  {
1722
1490
  toolName: "f5xc-api-waf-event-create",
@@ -1755,18 +1523,6 @@ export const wafTools = [
1755
1523
  creates: ["event"],
1756
1524
  },
1757
1525
  requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
1758
- cliExamples: [
1759
- {
1760
- command: "f5xcctl data event create {name} --namespace {namespace}",
1761
- description: "Create event",
1762
- use_case: "basic_create",
1763
- },
1764
- {
1765
- command: "f5xcctl data event create -f {file}.yaml",
1766
- description: "Create from YAML file",
1767
- use_case: "file_based",
1768
- },
1769
- ],
1770
1526
  confirmationRequired: false,
1771
1527
  parameterExamples: {
1772
1528
  namespace: "Bloggin-app-namespace-1.",
@@ -1811,18 +1567,6 @@ export const wafTools = [
1811
1567
  },
1812
1568
  confirmation_required: false,
1813
1569
  danger_level: "medium",
1814
- examples: [
1815
- {
1816
- command: "f5xcctl data event create {name} --namespace {namespace}",
1817
- description: "Create event",
1818
- use_case: "basic_create",
1819
- },
1820
- {
1821
- command: "f5xcctl data event create -f {file}.yaml",
1822
- description: "Create from YAML file",
1823
- use_case: "file_based",
1824
- },
1825
- ],
1826
1570
  field_docs: {},
1827
1571
  optional_fields: [],
1828
1572
  performance_impact: {
@@ -1835,6 +1579,7 @@ export const wafTools = [
1835
1579
  creates: ["event"],
1836
1580
  },
1837
1581
  },
1582
+ curlExample: null,
1838
1583
  },
1839
1584
  {
1840
1585
  toolName: "f5xc-api-waf-hit-create",
@@ -1875,18 +1620,6 @@ export const wafTools = [
1875
1620
  creates: ["hit"],
1876
1621
  },
1877
1622
  requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
1878
- cliExamples: [
1879
- {
1880
- command: "f5xcctl data hit create -f {file}.yaml",
1881
- description: "Create from YAML file",
1882
- use_case: "file_based",
1883
- },
1884
- {
1885
- command: "f5xcctl data hit create {name} --namespace {namespace}",
1886
- description: "Create hit",
1887
- use_case: "basic_create",
1888
- },
1889
- ],
1890
1623
  confirmationRequired: false,
1891
1624
  parameterExamples: {
1892
1625
  namespace: "Ns1",
@@ -1931,18 +1664,6 @@ export const wafTools = [
1931
1664
  },
1932
1665
  confirmation_required: false,
1933
1666
  danger_level: "medium",
1934
- examples: [
1935
- {
1936
- command: "f5xcctl data hit create {name} --namespace {namespace}",
1937
- description: "Create hit",
1938
- use_case: "basic_create",
1939
- },
1940
- {
1941
- command: "f5xcctl data hit create -f {file}.yaml",
1942
- description: "Create from YAML file",
1943
- use_case: "file_based",
1944
- },
1945
- ],
1946
1667
  field_docs: {},
1947
1668
  optional_fields: [],
1948
1669
  performance_impact: {
@@ -1955,6 +1676,7 @@ export const wafTools = [
1955
1676
  creates: ["hit"],
1956
1677
  },
1957
1678
  },
1679
+ curlExample: null,
1958
1680
  },
1959
1681
  {
1960
1682
  toolName: "f5xc-api-waf-incident-create",
@@ -1995,18 +1717,6 @@ export const wafTools = [
1995
1717
  creates: ["incident"],
1996
1718
  },
1997
1719
  requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
1998
- cliExamples: [
1999
- {
2000
- command: "f5xcctl data incident create -f {file}.yaml",
2001
- description: "Create from YAML file",
2002
- use_case: "file_based",
2003
- },
2004
- {
2005
- command: "f5xcctl data incident create {name} --namespace {namespace}",
2006
- description: "Create incident",
2007
- use_case: "basic_create",
2008
- },
2009
- ],
2010
1720
  confirmationRequired: false,
2011
1721
  parameterExamples: {
2012
1722
  namespace: "Bloggin-app-namespace-1.",
@@ -2051,18 +1761,6 @@ export const wafTools = [
2051
1761
  },
2052
1762
  confirmation_required: false,
2053
1763
  danger_level: "medium",
2054
- examples: [
2055
- {
2056
- command: "f5xcctl data incident create {name} --namespace {namespace}",
2057
- description: "Create incident",
2058
- use_case: "basic_create",
2059
- },
2060
- {
2061
- command: "f5xcctl data incident create -f {file}.yaml",
2062
- description: "Create from YAML file",
2063
- use_case: "file_based",
2064
- },
2065
- ],
2066
1764
  field_docs: {},
2067
1765
  optional_fields: [],
2068
1766
  performance_impact: {
@@ -2075,6 +1773,7 @@ export const wafTools = [
2075
1773
  creates: ["incident"],
2076
1774
  },
2077
1775
  },
1776
+ curlExample: null,
2078
1777
  },
2079
1778
  {
2080
1779
  toolName: "f5xc-api-waf-loadbalancer-create",
@@ -2101,18 +1800,6 @@ export const wafTools = [
2101
1800
  creates: ["loadbalancer"],
2102
1801
  },
2103
1802
  requiredFields: ["metadata.name", "metadata.namespace"],
2104
- cliExamples: [
2105
- {
2106
- command: "f5xcctl data loadbalancer create -f {file}.yaml",
2107
- description: "Create from YAML file",
2108
- use_case: "file_based",
2109
- },
2110
- {
2111
- command: "f5xcctl data loadbalancer create {name} --namespace {namespace}",
2112
- description: "Create loadbalancer",
2113
- use_case: "basic_create",
2114
- },
2115
- ],
2116
1803
  confirmationRequired: false,
2117
1804
  parameterExamples: {},
2118
1805
  validationRules: {},
@@ -2155,18 +1842,6 @@ export const wafTools = [
2155
1842
  },
2156
1843
  confirmation_required: false,
2157
1844
  danger_level: "medium",
2158
- examples: [
2159
- {
2160
- command: "f5xcctl data loadbalancer create {name} --namespace {namespace}",
2161
- description: "Create loadbalancer",
2162
- use_case: "basic_create",
2163
- },
2164
- {
2165
- command: "f5xcctl data loadbalancer create -f {file}.yaml",
2166
- description: "Create from YAML file",
2167
- use_case: "file_based",
2168
- },
2169
- ],
2170
1845
  field_docs: {},
2171
1846
  optional_fields: [],
2172
1847
  performance_impact: {
@@ -2179,6 +1854,7 @@ export const wafTools = [
2179
1854
  creates: ["loadbalancer"],
2180
1855
  },
2181
1856
  },
1857
+ curlExample: null,
2182
1858
  },
2183
1859
  {
2184
1860
  toolName: "f5xc-api-waf-metric-create",
@@ -2217,18 +1893,6 @@ export const wafTools = [
2217
1893
  creates: ["metric"],
2218
1894
  },
2219
1895
  requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
2220
- cliExamples: [
2221
- {
2222
- command: "f5xcctl data metric create -f {file}.yaml",
2223
- description: "Create from YAML file",
2224
- use_case: "file_based",
2225
- },
2226
- {
2227
- command: "f5xcctl data metric create {name} --namespace {namespace}",
2228
- description: "Create metric",
2229
- use_case: "basic_create",
2230
- },
2231
- ],
2232
1896
  confirmationRequired: false,
2233
1897
  parameterExamples: {
2234
1898
  namespace: "System",
@@ -2273,18 +1937,6 @@ export const wafTools = [
2273
1937
  },
2274
1938
  confirmation_required: false,
2275
1939
  danger_level: "medium",
2276
- examples: [
2277
- {
2278
- command: "f5xcctl data metric create {name} --namespace {namespace}",
2279
- description: "Create metric",
2280
- use_case: "basic_create",
2281
- },
2282
- {
2283
- command: "f5xcctl data metric create -f {file}.yaml",
2284
- description: "Create from YAML file",
2285
- use_case: "file_based",
2286
- },
2287
- ],
2288
1940
  field_docs: {},
2289
1941
  optional_fields: [],
2290
1942
  performance_impact: {
@@ -2297,6 +1949,7 @@ export const wafTools = [
2297
1949
  creates: ["metric"],
2298
1950
  },
2299
1951
  },
1952
+ curlExample: null,
2300
1953
  },
2301
1954
  {
2302
1955
  toolName: "f5xc-api-waf-protocol-inspection-create",
@@ -2337,18 +1990,6 @@ export const wafTools = [
2337
1990
  creates: ["protocol-inspection"],
2338
1991
  },
2339
1992
  requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
2340
- cliExamples: [
2341
- {
2342
- command: "f5xcctl config protocol-inspection create -f {file}.yaml",
2343
- description: "Create from YAML file",
2344
- use_case: "file_based",
2345
- },
2346
- {
2347
- command: "f5xcctl config protocol-inspection create {name} --namespace {namespace}",
2348
- description: "Create protocol-inspection",
2349
- use_case: "basic_create",
2350
- },
2351
- ],
2352
1993
  confirmationRequired: false,
2353
1994
  parameterExamples: {
2354
1995
  "metadata.namespace": "Staging",
@@ -2396,18 +2037,6 @@ export const wafTools = [
2396
2037
  },
2397
2038
  confirmation_required: false,
2398
2039
  danger_level: "medium",
2399
- examples: [
2400
- {
2401
- command: "f5xcctl config protocol-inspection create {name} --namespace {namespace}",
2402
- description: "Create protocol-inspection",
2403
- use_case: "basic_create",
2404
- },
2405
- {
2406
- command: "f5xcctl config protocol-inspection create -f {file}.yaml",
2407
- description: "Create from YAML file",
2408
- use_case: "file_based",
2409
- },
2410
- ],
2411
2040
  field_docs: {},
2412
2041
  optional_fields: [],
2413
2042
  performance_impact: {
@@ -2420,6 +2049,7 @@ export const wafTools = [
2420
2049
  creates: ["protocol-inspection"],
2421
2050
  },
2422
2051
  },
2052
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/protocol_inspections" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
2423
2053
  },
2424
2054
  {
2425
2055
  toolName: "f5xc-api-waf-protocol-inspection-delete",
@@ -2469,13 +2099,6 @@ export const wafTools = [
2469
2099
  deletes: ["protocol-inspection", "contained_resources"],
2470
2100
  },
2471
2101
  requiredFields: ["path.name", "path.namespace"],
2472
- cliExamples: [
2473
- {
2474
- command: "f5xcctl config protocol-inspection delete {name} --namespace {namespace}",
2475
- description: "Delete protocol-inspection",
2476
- use_case: "delete",
2477
- },
2478
- ],
2479
2102
  confirmationRequired: true,
2480
2103
  parameterExamples: {
2481
2104
  name: "Name",
@@ -2521,13 +2144,6 @@ export const wafTools = [
2521
2144
  },
2522
2145
  confirmation_required: true,
2523
2146
  danger_level: "high",
2524
- examples: [
2525
- {
2526
- command: "f5xcctl config protocol-inspection delete {name} --namespace {namespace}",
2527
- description: "Delete protocol-inspection",
2528
- use_case: "delete",
2529
- },
2530
- ],
2531
2147
  field_docs: {},
2532
2148
  optional_fields: [],
2533
2149
  performance_impact: {
@@ -2540,6 +2156,7 @@ export const wafTools = [
2540
2156
  deletes: ["protocol-inspection", "contained_resources"],
2541
2157
  },
2542
2158
  },
2159
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/protocol_inspections" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
2543
2160
  },
2544
2161
  {
2545
2162
  toolName: "f5xc-api-waf-protocol-inspection-get",
@@ -2608,13 +2225,6 @@ export const wafTools = [
2608
2225
  dangerLevel: "low",
2609
2226
  sideEffects: null,
2610
2227
  requiredFields: ["path.name", "path.namespace"],
2611
- cliExamples: [
2612
- {
2613
- command: "f5xcctl config protocol-inspection get {name} --namespace {namespace}",
2614
- description: "Get specific protocol-inspection",
2615
- use_case: "get_specific",
2616
- },
2617
- ],
2618
2228
  confirmationRequired: false,
2619
2229
  parameterExamples: {
2620
2230
  name: "Name",
@@ -2660,13 +2270,6 @@ export const wafTools = [
2660
2270
  },
2661
2271
  confirmation_required: false,
2662
2272
  danger_level: "low",
2663
- examples: [
2664
- {
2665
- command: "f5xcctl config protocol-inspection get {name} --namespace {namespace}",
2666
- description: "Get specific protocol-inspection",
2667
- use_case: "get_specific",
2668
- },
2669
- ],
2670
2273
  field_docs: {},
2671
2274
  optional_fields: [],
2672
2275
  performance_impact: {
@@ -2677,6 +2280,7 @@ export const wafTools = [
2677
2280
  required_fields: ["path.name", "path.namespace"],
2678
2281
  side_effects: {},
2679
2282
  },
2283
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/protocol_inspections" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
2680
2284
  },
2681
2285
  {
2682
2286
  toolName: "f5xc-api-waf-protocol-inspection-list",
@@ -2751,13 +2355,6 @@ export const wafTools = [
2751
2355
  dangerLevel: "low",
2752
2356
  sideEffects: null,
2753
2357
  requiredFields: ["path.namespace"],
2754
- cliExamples: [
2755
- {
2756
- command: "f5xcctl config protocol-inspection list --namespace {namespace}",
2757
- description: "List all protocol-inspections",
2758
- use_case: "list_all",
2759
- },
2760
- ],
2761
2358
  confirmationRequired: false,
2762
2359
  parameterExamples: {
2763
2360
  label_filter: "Env in (staging, testing), tier in (web, db)",
@@ -2803,13 +2400,6 @@ export const wafTools = [
2803
2400
  },
2804
2401
  confirmation_required: false,
2805
2402
  danger_level: "low",
2806
- examples: [
2807
- {
2808
- command: "f5xcctl config protocol-inspection list --namespace {namespace}",
2809
- description: "List all protocol-inspections",
2810
- use_case: "list_all",
2811
- },
2812
- ],
2813
2403
  field_docs: {},
2814
2404
  optional_fields: [],
2815
2405
  performance_impact: {
@@ -2820,6 +2410,7 @@ export const wafTools = [
2820
2410
  required_fields: ["path.namespace"],
2821
2411
  side_effects: {},
2822
2412
  },
2413
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/protocol_inspections" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
2823
2414
  },
2824
2415
  {
2825
2416
  toolName: "f5xc-api-waf-protocol-inspection-update",
@@ -2871,13 +2462,6 @@ export const wafTools = [
2871
2462
  modifies: ["protocol-inspection"],
2872
2463
  },
2873
2464
  requiredFields: ["path.metadata.name", "path.metadata.namespace"],
2874
- cliExamples: [
2875
- {
2876
- command: "f5xcctl config protocol-inspection update {name} --namespace {namespace} -f {file}.yaml",
2877
- description: "Update protocol-inspection",
2878
- use_case: "update",
2879
- },
2880
- ],
2881
2465
  confirmationRequired: false,
2882
2466
  parameterExamples: {
2883
2467
  "metadata.name": "Example-corp-web.",
@@ -2923,13 +2507,6 @@ export const wafTools = [
2923
2507
  },
2924
2508
  confirmation_required: false,
2925
2509
  danger_level: "medium",
2926
- examples: [
2927
- {
2928
- command: "f5xcctl config protocol-inspection update {name} --namespace {namespace} -f {file}.yaml",
2929
- description: "Update protocol-inspection",
2930
- use_case: "update",
2931
- },
2932
- ],
2933
2510
  field_docs: {},
2934
2511
  optional_fields: [],
2935
2512
  performance_impact: {
@@ -2942,6 +2519,7 @@ export const wafTools = [
2942
2519
  modifies: ["protocol-inspection"],
2943
2520
  },
2944
2521
  },
2522
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/protocol_inspections" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
2945
2523
  },
2946
2524
  {
2947
2525
  toolName: "f5xc-api-waf-released-signature-list",
@@ -2989,13 +2567,6 @@ export const wafTools = [
2989
2567
  dangerLevel: "low",
2990
2568
  sideEffects: null,
2991
2569
  requiredFields: ["path.namespace", "path.vh_name"],
2992
- cliExamples: [
2993
- {
2994
- command: "f5xcctl config released-signature list --namespace {namespace}",
2995
- description: "List all released-signatures",
2996
- use_case: "list_all",
2997
- },
2998
- ],
2999
2570
  confirmationRequired: false,
3000
2571
  parameterExamples: {
3001
2572
  namespace: "Shared",
@@ -3041,13 +2612,6 @@ export const wafTools = [
3041
2612
  },
3042
2613
  confirmation_required: false,
3043
2614
  danger_level: "low",
3044
- examples: [
3045
- {
3046
- command: "f5xcctl config released-signature list --namespace {namespace}",
3047
- description: "List all released-signatures",
3048
- use_case: "list_all",
3049
- },
3050
- ],
3051
2615
  field_docs: {},
3052
2616
  optional_fields: [],
3053
2617
  performance_impact: {
@@ -3058,6 +2622,7 @@ export const wafTools = [
3058
2622
  required_fields: ["path.namespace", "path.vh_name"],
3059
2623
  side_effects: {},
3060
2624
  },
2625
+ curlExample: null,
3061
2626
  },
3062
2627
  {
3063
2628
  toolName: "f5xc-api-waf-rule-hit-create",
@@ -3096,18 +2661,6 @@ export const wafTools = [
3096
2661
  creates: ["rule-hit"],
3097
2662
  },
3098
2663
  requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
3099
- cliExamples: [
3100
- {
3101
- command: "f5xcctl data rule-hit create -f {file}.yaml",
3102
- description: "Create from YAML file",
3103
- use_case: "file_based",
3104
- },
3105
- {
3106
- command: "f5xcctl data rule-hit create {name} --namespace {namespace}",
3107
- description: "Create rule-hit",
3108
- use_case: "basic_create",
3109
- },
3110
- ],
3111
2664
  confirmationRequired: false,
3112
2665
  parameterExamples: {
3113
2666
  namespace: "Bloggin-app-namespace-1.",
@@ -3152,18 +2705,6 @@ export const wafTools = [
3152
2705
  },
3153
2706
  confirmation_required: false,
3154
2707
  danger_level: "medium",
3155
- examples: [
3156
- {
3157
- command: "f5xcctl data rule-hit create {name} --namespace {namespace}",
3158
- description: "Create rule-hit",
3159
- use_case: "basic_create",
3160
- },
3161
- {
3162
- command: "f5xcctl data rule-hit create -f {file}.yaml",
3163
- description: "Create from YAML file",
3164
- use_case: "file_based",
3165
- },
3166
- ],
3167
2708
  field_docs: {},
3168
2709
  optional_fields: [],
3169
2710
  performance_impact: {
@@ -3176,6 +2717,7 @@ export const wafTools = [
3176
2717
  creates: ["rule-hit"],
3177
2718
  },
3178
2719
  },
2720
+ curlExample: null,
3179
2721
  },
3180
2722
  {
3181
2723
  toolName: "f5xc-api-waf-scroll-create",
@@ -3216,18 +2758,6 @@ export const wafTools = [
3216
2758
  creates: ["scroll"],
3217
2759
  },
3218
2760
  requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
3219
- cliExamples: [
3220
- {
3221
- command: "f5xcctl data scroll create -f {file}.yaml",
3222
- description: "Create from YAML file",
3223
- use_case: "file_based",
3224
- },
3225
- {
3226
- command: "f5xcctl data scroll create {name} --namespace {namespace}",
3227
- description: "Create scroll",
3228
- use_case: "basic_create",
3229
- },
3230
- ],
3231
2761
  confirmationRequired: false,
3232
2762
  parameterExamples: {
3233
2763
  namespace: "Bloggin-app-namespace-1.",
@@ -3272,18 +2802,6 @@ export const wafTools = [
3272
2802
  },
3273
2803
  confirmation_required: false,
3274
2804
  danger_level: "medium",
3275
- examples: [
3276
- {
3277
- command: "f5xcctl data scroll create {name} --namespace {namespace}",
3278
- description: "Create scroll",
3279
- use_case: "basic_create",
3280
- },
3281
- {
3282
- command: "f5xcctl data scroll create -f {file}.yaml",
3283
- description: "Create from YAML file",
3284
- use_case: "file_based",
3285
- },
3286
- ],
3287
2805
  field_docs: {},
3288
2806
  optional_fields: [],
3289
2807
  performance_impact: {
@@ -3296,6 +2814,7 @@ export const wafTools = [
3296
2814
  creates: ["scroll"],
3297
2815
  },
3298
2816
  },
2817
+ curlExample: null,
3299
2818
  },
3300
2819
  {
3301
2820
  toolName: "f5xc-api-waf-scroll-list",
@@ -3344,13 +2863,6 @@ export const wafTools = [
3344
2863
  dangerLevel: "low",
3345
2864
  sideEffects: null,
3346
2865
  requiredFields: ["path.namespace"],
3347
- cliExamples: [
3348
- {
3349
- command: "f5xcctl data scroll list --namespace {namespace}",
3350
- description: "List all scrolls",
3351
- use_case: "list_all",
3352
- },
3353
- ],
3354
2866
  confirmationRequired: false,
3355
2867
  parameterExamples: {
3356
2868
  namespace: "Bloggin-app-namespace-1.",
@@ -3396,13 +2908,6 @@ export const wafTools = [
3396
2908
  },
3397
2909
  confirmation_required: false,
3398
2910
  danger_level: "low",
3399
- examples: [
3400
- {
3401
- command: "f5xcctl data scroll list --namespace {namespace}",
3402
- description: "List all scrolls",
3403
- use_case: "list_all",
3404
- },
3405
- ],
3406
2911
  field_docs: {},
3407
2912
  optional_fields: [],
3408
2913
  performance_impact: {
@@ -3413,6 +2918,7 @@ export const wafTools = [
3413
2918
  required_fields: ["path.namespace"],
3414
2919
  side_effects: {},
3415
2920
  },
2921
+ curlExample: null,
3416
2922
  },
3417
2923
  {
3418
2924
  toolName: "f5xc-api-waf-security-event-create",
@@ -3451,18 +2957,6 @@ export const wafTools = [
3451
2957
  creates: ["security-event"],
3452
2958
  },
3453
2959
  requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
3454
- cliExamples: [
3455
- {
3456
- command: "f5xcctl data security-event create -f {file}.yaml",
3457
- description: "Create from YAML file",
3458
- use_case: "file_based",
3459
- },
3460
- {
3461
- command: "f5xcctl data security-event create {name} --namespace {namespace}",
3462
- description: "Create security-event",
3463
- use_case: "basic_create",
3464
- },
3465
- ],
3466
2960
  confirmationRequired: false,
3467
2961
  parameterExamples: {
3468
2962
  namespace: "Bloggin-app-namespace-1.",
@@ -3507,18 +3001,6 @@ export const wafTools = [
3507
3001
  },
3508
3002
  confirmation_required: false,
3509
3003
  danger_level: "medium",
3510
- examples: [
3511
- {
3512
- command: "f5xcctl data security-event create {name} --namespace {namespace}",
3513
- description: "Create security-event",
3514
- use_case: "basic_create",
3515
- },
3516
- {
3517
- command: "f5xcctl data security-event create -f {file}.yaml",
3518
- description: "Create from YAML file",
3519
- use_case: "file_based",
3520
- },
3521
- ],
3522
3004
  field_docs: {},
3523
3005
  optional_fields: [],
3524
3006
  performance_impact: {
@@ -3531,6 +3013,7 @@ export const wafTools = [
3531
3013
  creates: ["security-event"],
3532
3014
  },
3533
3015
  },
3016
+ curlExample: null,
3534
3017
  },
3535
3018
  {
3536
3019
  toolName: "f5xc-api-waf-staged-signature-create",
@@ -3582,18 +3065,6 @@ export const wafTools = [
3582
3065
  creates: ["staged-signature"],
3583
3066
  },
3584
3067
  requiredFields: ["metadata.name", "metadata.namespace", "path.namespace", "path.vh_name"],
3585
- cliExamples: [
3586
- {
3587
- command: "f5xcctl ml staged-signature create -f {file}.yaml",
3588
- description: "Create from YAML file",
3589
- use_case: "file_based",
3590
- },
3591
- {
3592
- command: "f5xcctl ml staged-signature create {name} --namespace {namespace}",
3593
- description: "Create staged-signature",
3594
- use_case: "basic_create",
3595
- },
3596
- ],
3597
3068
  confirmationRequired: false,
3598
3069
  parameterExamples: {
3599
3070
  namespace: "Shared",
@@ -3642,18 +3113,6 @@ export const wafTools = [
3642
3113
  },
3643
3114
  confirmation_required: false,
3644
3115
  danger_level: "medium",
3645
- examples: [
3646
- {
3647
- command: "f5xcctl ml staged-signature create {name} --namespace {namespace}",
3648
- description: "Create staged-signature",
3649
- use_case: "basic_create",
3650
- },
3651
- {
3652
- command: "f5xcctl ml staged-signature create -f {file}.yaml",
3653
- description: "Create from YAML file",
3654
- use_case: "file_based",
3655
- },
3656
- ],
3657
3116
  field_docs: {},
3658
3117
  optional_fields: [],
3659
3118
  performance_impact: {
@@ -3666,6 +3125,7 @@ export const wafTools = [
3666
3125
  creates: ["staged-signature"],
3667
3126
  },
3668
3127
  },
3128
+ curlExample: null,
3669
3129
  },
3670
3130
  {
3671
3131
  toolName: "f5xc-api-waf-suspicious-user-log-create",
@@ -3706,18 +3166,6 @@ export const wafTools = [
3706
3166
  creates: ["suspicious-user-log"],
3707
3167
  },
3708
3168
  requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
3709
- cliExamples: [
3710
- {
3711
- command: "f5xcctl data suspicious-user-log create -f {file}.yaml",
3712
- description: "Create from YAML file",
3713
- use_case: "file_based",
3714
- },
3715
- {
3716
- command: "f5xcctl data suspicious-user-log create {name} --namespace {namespace}",
3717
- description: "Create suspicious-user-log",
3718
- use_case: "basic_create",
3719
- },
3720
- ],
3721
3169
  confirmationRequired: false,
3722
3170
  parameterExamples: {
3723
3171
  namespace: "Bloggin-app-namespace-1.",
@@ -3765,18 +3213,6 @@ export const wafTools = [
3765
3213
  },
3766
3214
  confirmation_required: false,
3767
3215
  danger_level: "medium",
3768
- examples: [
3769
- {
3770
- command: "f5xcctl data suspicious-user-log create {name} --namespace {namespace}",
3771
- description: "Create suspicious-user-log",
3772
- use_case: "basic_create",
3773
- },
3774
- {
3775
- command: "f5xcctl data suspicious-user-log create -f {file}.yaml",
3776
- description: "Create from YAML file",
3777
- use_case: "file_based",
3778
- },
3779
- ],
3780
3216
  field_docs: {},
3781
3217
  optional_fields: [],
3782
3218
  performance_impact: {
@@ -3789,6 +3225,7 @@ export const wafTools = [
3789
3225
  creates: ["suspicious-user-log"],
3790
3226
  },
3791
3227
  },
3228
+ curlExample: null,
3792
3229
  },
3793
3230
  {
3794
3231
  toolName: "f5xc-api-waf-waf-exclusion-policy-create",
@@ -3829,18 +3266,6 @@ export const wafTools = [
3829
3266
  creates: ["waf-exclusion-policy"],
3830
3267
  },
3831
3268
  requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
3832
- cliExamples: [
3833
- {
3834
- command: "f5xcctl config waf-exclusion-policy create -f {file}.yaml",
3835
- description: "Create from YAML file",
3836
- use_case: "file_based",
3837
- },
3838
- {
3839
- command: "f5xcctl config waf-exclusion-policy create {name} --namespace {namespace}",
3840
- description: "Create waf-exclusion-policy",
3841
- use_case: "basic_create",
3842
- },
3843
- ],
3844
3269
  confirmationRequired: false,
3845
3270
  parameterExamples: {
3846
3271
  "metadata.namespace": "Staging",
@@ -3888,18 +3313,6 @@ export const wafTools = [
3888
3313
  },
3889
3314
  confirmation_required: false,
3890
3315
  danger_level: "medium",
3891
- examples: [
3892
- {
3893
- command: "f5xcctl config waf-exclusion-policy create {name} --namespace {namespace}",
3894
- description: "Create waf-exclusion-policy",
3895
- use_case: "basic_create",
3896
- },
3897
- {
3898
- command: "f5xcctl config waf-exclusion-policy create -f {file}.yaml",
3899
- description: "Create from YAML file",
3900
- use_case: "file_based",
3901
- },
3902
- ],
3903
3316
  field_docs: {},
3904
3317
  optional_fields: [],
3905
3318
  performance_impact: {
@@ -3912,6 +3325,7 @@ export const wafTools = [
3912
3325
  creates: ["waf-exclusion-policy"],
3913
3326
  },
3914
3327
  },
3328
+ curlExample: null,
3915
3329
  },
3916
3330
  {
3917
3331
  toolName: "f5xc-api-waf-waf-exclusion-policy-delete",
@@ -3961,13 +3375,6 @@ export const wafTools = [
3961
3375
  deletes: ["waf-exclusion-policy", "contained_resources"],
3962
3376
  },
3963
3377
  requiredFields: ["path.name", "path.namespace"],
3964
- cliExamples: [
3965
- {
3966
- command: "f5xcctl config waf-exclusion-policy delete {name} --namespace {namespace}",
3967
- description: "Delete waf-exclusion-policy",
3968
- use_case: "delete",
3969
- },
3970
- ],
3971
3378
  confirmationRequired: true,
3972
3379
  parameterExamples: {
3973
3380
  name: "Name",
@@ -4013,13 +3420,6 @@ export const wafTools = [
4013
3420
  },
4014
3421
  confirmation_required: true,
4015
3422
  danger_level: "high",
4016
- examples: [
4017
- {
4018
- command: "f5xcctl config waf-exclusion-policy delete {name} --namespace {namespace}",
4019
- description: "Delete waf-exclusion-policy",
4020
- use_case: "delete",
4021
- },
4022
- ],
4023
3423
  field_docs: {},
4024
3424
  optional_fields: [],
4025
3425
  performance_impact: {
@@ -4032,6 +3432,7 @@ export const wafTools = [
4032
3432
  deletes: ["waf-exclusion-policy", "contained_resources"],
4033
3433
  },
4034
3434
  },
3435
+ curlExample: null,
4035
3436
  },
4036
3437
  {
4037
3438
  toolName: "f5xc-api-waf-waf-exclusion-policy-get",
@@ -4100,13 +3501,6 @@ export const wafTools = [
4100
3501
  dangerLevel: "low",
4101
3502
  sideEffects: null,
4102
3503
  requiredFields: ["path.name", "path.namespace"],
4103
- cliExamples: [
4104
- {
4105
- command: "f5xcctl config waf-exclusion-policy get {name} --namespace {namespace}",
4106
- description: "Get specific waf-exclusion-policy",
4107
- use_case: "get_specific",
4108
- },
4109
- ],
4110
3504
  confirmationRequired: false,
4111
3505
  parameterExamples: {
4112
3506
  name: "Name",
@@ -4152,13 +3546,6 @@ export const wafTools = [
4152
3546
  },
4153
3547
  confirmation_required: false,
4154
3548
  danger_level: "low",
4155
- examples: [
4156
- {
4157
- command: "f5xcctl config waf-exclusion-policy get {name} --namespace {namespace}",
4158
- description: "Get specific waf-exclusion-policy",
4159
- use_case: "get_specific",
4160
- },
4161
- ],
4162
3549
  field_docs: {},
4163
3550
  optional_fields: [],
4164
3551
  performance_impact: {
@@ -4169,6 +3556,7 @@ export const wafTools = [
4169
3556
  required_fields: ["path.name", "path.namespace"],
4170
3557
  side_effects: {},
4171
3558
  },
3559
+ curlExample: null,
4172
3560
  },
4173
3561
  {
4174
3562
  toolName: "f5xc-api-waf-waf-exclusion-policy-list",
@@ -4243,13 +3631,6 @@ export const wafTools = [
4243
3631
  dangerLevel: "low",
4244
3632
  sideEffects: null,
4245
3633
  requiredFields: ["path.namespace"],
4246
- cliExamples: [
4247
- {
4248
- command: "f5xcctl config waf-exclusion-policy list --namespace {namespace}",
4249
- description: "List all waf-exclusion-policys",
4250
- use_case: "list_all",
4251
- },
4252
- ],
4253
3634
  confirmationRequired: false,
4254
3635
  parameterExamples: {
4255
3636
  label_filter: "Env in (staging, testing), tier in (web, db)",
@@ -4295,13 +3676,6 @@ export const wafTools = [
4295
3676
  },
4296
3677
  confirmation_required: false,
4297
3678
  danger_level: "low",
4298
- examples: [
4299
- {
4300
- command: "f5xcctl config waf-exclusion-policy list --namespace {namespace}",
4301
- description: "List all waf-exclusion-policys",
4302
- use_case: "list_all",
4303
- },
4304
- ],
4305
3679
  field_docs: {},
4306
3680
  optional_fields: [],
4307
3681
  performance_impact: {
@@ -4312,6 +3686,7 @@ export const wafTools = [
4312
3686
  required_fields: ["path.namespace"],
4313
3687
  side_effects: {},
4314
3688
  },
3689
+ curlExample: null,
4315
3690
  },
4316
3691
  {
4317
3692
  toolName: "f5xc-api-waf-waf-exclusion-policy-update",
@@ -4363,13 +3738,6 @@ export const wafTools = [
4363
3738
  modifies: ["waf-exclusion-policy"],
4364
3739
  },
4365
3740
  requiredFields: ["path.metadata.name", "path.metadata.namespace"],
4366
- cliExamples: [
4367
- {
4368
- command: "f5xcctl config waf-exclusion-policy update {name} --namespace {namespace} -f {file}.yaml",
4369
- description: "Update waf-exclusion-policy",
4370
- use_case: "update",
4371
- },
4372
- ],
4373
3741
  confirmationRequired: false,
4374
3742
  parameterExamples: {
4375
3743
  "metadata.name": "Example-corp-web.",
@@ -4415,13 +3783,6 @@ export const wafTools = [
4415
3783
  },
4416
3784
  confirmation_required: false,
4417
3785
  danger_level: "medium",
4418
- examples: [
4419
- {
4420
- command: "f5xcctl config waf-exclusion-policy update {name} --namespace {namespace} -f {file}.yaml",
4421
- description: "Update waf-exclusion-policy",
4422
- use_case: "update",
4423
- },
4424
- ],
4425
3786
  field_docs: {},
4426
3787
  optional_fields: [],
4427
3788
  performance_impact: {
@@ -4434,6 +3795,7 @@ export const wafTools = [
4434
3795
  modifies: ["waf-exclusion-policy"],
4435
3796
  },
4436
3797
  },
3798
+ curlExample: null,
4437
3799
  },
4438
3800
  ];
4439
3801
  export default wafTools;