@robinmordasiewicz/f5xc-api-mcp 3.3.0 → 3.4.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 (235) hide show
  1. package/dist/generator/openapi-parser.d.ts +418 -0
  2. package/dist/generator/openapi-parser.d.ts.map +1 -1
  3. package/dist/generator/openapi-parser.js +132 -0
  4. package/dist/generator/openapi-parser.js.map +1 -1
  5. package/dist/generator/tool-generator.d.ts +29 -1
  6. package/dist/generator/tool-generator.d.ts.map +1 -1
  7. package/dist/generator/tool-generator.js +150 -7
  8. package/dist/generator/tool-generator.js.map +1 -1
  9. package/dist/tools/discovery/describe.d.ts +1 -0
  10. package/dist/tools/discovery/describe.d.ts.map +1 -1
  11. package/dist/tools/discovery/describe.js +10 -8
  12. package/dist/tools/discovery/describe.js.map +1 -1
  13. package/dist/tools/generated/admin_console_and_ui/index.d.ts +8 -0
  14. package/dist/tools/generated/admin_console_and_ui/index.d.ts.map +1 -0
  15. package/dist/tools/generated/admin_console_and_ui/index.js +285 -0
  16. package/dist/tools/generated/admin_console_and_ui/index.js.map +1 -0
  17. package/dist/tools/generated/api/index.d.ts +8 -0
  18. package/dist/tools/generated/{vpn → api}/index.d.ts.map +1 -1
  19. package/dist/tools/generated/api/index.js +6668 -0
  20. package/dist/tools/generated/api/index.js.map +1 -0
  21. package/dist/tools/generated/authentication/index.d.ts +8 -0
  22. package/dist/tools/generated/authentication/index.d.ts.map +1 -0
  23. package/dist/tools/generated/authentication/index.js +1005 -0
  24. package/dist/tools/generated/authentication/index.js.map +1 -0
  25. package/dist/tools/generated/bigip/index.d.ts.map +1 -1
  26. package/dist/tools/generated/bigip/index.js +2045 -0
  27. package/dist/tools/generated/bigip/index.js.map +1 -1
  28. package/dist/tools/generated/billing_and_usage/index.d.ts +8 -0
  29. package/dist/tools/generated/billing_and_usage/index.d.ts.map +1 -0
  30. package/dist/tools/generated/billing_and_usage/index.js +2702 -0
  31. package/dist/tools/generated/billing_and_usage/index.js.map +1 -0
  32. package/dist/tools/generated/blindfold/index.d.ts +8 -0
  33. package/dist/tools/generated/blindfold/index.d.ts.map +1 -0
  34. package/dist/tools/generated/blindfold/index.js +3998 -0
  35. package/dist/tools/generated/blindfold/index.js.map +1 -0
  36. package/dist/tools/generated/bot_and_threat_defense/index.d.ts +8 -0
  37. package/dist/tools/generated/bot_and_threat_defense/index.d.ts.map +1 -0
  38. package/dist/tools/generated/bot_and_threat_defense/index.js +2584 -0
  39. package/dist/tools/generated/bot_and_threat_defense/index.js.map +1 -0
  40. package/dist/tools/generated/cdn/index.d.ts.map +1 -1
  41. package/dist/tools/generated/cdn/index.js +1904 -0
  42. package/dist/tools/generated/cdn/index.js.map +1 -1
  43. package/dist/tools/generated/ce_management/index.d.ts +8 -0
  44. package/dist/tools/generated/ce_management/index.d.ts.map +1 -0
  45. package/dist/tools/generated/ce_management/index.js +3963 -0
  46. package/dist/tools/generated/ce_management/index.js.map +1 -0
  47. package/dist/tools/generated/certificates/index.d.ts +8 -0
  48. package/dist/tools/generated/certificates/index.d.ts.map +1 -0
  49. package/dist/tools/generated/certificates/index.js +2579 -0
  50. package/dist/tools/generated/certificates/index.js.map +1 -0
  51. package/dist/tools/generated/cloud_infrastructure/index.d.ts +8 -0
  52. package/dist/tools/generated/cloud_infrastructure/index.d.ts.map +1 -0
  53. package/dist/tools/generated/cloud_infrastructure/index.js +4124 -0
  54. package/dist/tools/generated/cloud_infrastructure/index.js.map +1 -0
  55. package/dist/tools/generated/container_services/index.d.ts +8 -0
  56. package/dist/tools/generated/container_services/index.d.ts.map +1 -0
  57. package/dist/tools/generated/container_services/index.js +2054 -0
  58. package/dist/tools/generated/container_services/index.js.map +1 -0
  59. package/dist/tools/generated/data_and_privacy_security/index.d.ts +8 -0
  60. package/dist/tools/generated/data_and_privacy_security/index.d.ts.map +1 -0
  61. package/dist/tools/generated/data_and_privacy_security/index.js +1708 -0
  62. package/dist/tools/generated/data_and_privacy_security/index.js.map +1 -0
  63. package/dist/tools/generated/data_intelligence/index.d.ts +8 -0
  64. package/dist/tools/generated/data_intelligence/index.d.ts.map +1 -0
  65. package/dist/tools/generated/data_intelligence/index.js +1770 -0
  66. package/dist/tools/generated/data_intelligence/index.js.map +1 -0
  67. package/dist/tools/generated/ddos/index.d.ts +8 -0
  68. package/dist/tools/generated/ddos/index.d.ts.map +1 -0
  69. package/dist/tools/generated/ddos/index.js +8511 -0
  70. package/dist/tools/generated/ddos/index.js.map +1 -0
  71. package/dist/tools/generated/dns/index.d.ts +8 -0
  72. package/dist/tools/generated/dns/index.d.ts.map +1 -0
  73. package/dist/tools/generated/dns/index.js +6460 -0
  74. package/dist/tools/generated/dns/index.js.map +1 -0
  75. package/dist/tools/generated/generative_ai/index.d.ts +8 -0
  76. package/dist/tools/generated/generative_ai/index.d.ts.map +1 -0
  77. package/dist/tools/generated/generative_ai/index.js +1215 -0
  78. package/dist/tools/generated/generative_ai/index.js.map +1 -0
  79. package/dist/tools/generated/managed_kubernetes/index.d.ts +8 -0
  80. package/dist/tools/generated/managed_kubernetes/index.d.ts.map +1 -0
  81. package/dist/tools/generated/managed_kubernetes/index.js +3233 -0
  82. package/dist/tools/generated/managed_kubernetes/index.js.map +1 -0
  83. package/dist/tools/generated/marketplace/index.d.ts +8 -0
  84. package/dist/tools/generated/marketplace/index.d.ts.map +1 -0
  85. package/dist/tools/generated/marketplace/index.js +4580 -0
  86. package/dist/tools/generated/marketplace/index.js.map +1 -0
  87. package/dist/tools/generated/network/index.d.ts +8 -0
  88. package/dist/tools/generated/network/index.d.ts.map +1 -0
  89. package/dist/tools/generated/network/index.js +12616 -0
  90. package/dist/tools/generated/network/index.js.map +1 -0
  91. package/dist/tools/generated/network_security/index.d.ts +8 -0
  92. package/dist/tools/generated/network_security/index.d.ts.map +1 -0
  93. package/dist/tools/generated/network_security/index.js +8884 -0
  94. package/dist/tools/generated/network_security/index.js.map +1 -0
  95. package/dist/tools/generated/nginx_one/index.d.ts +8 -0
  96. package/dist/tools/generated/nginx_one/index.d.ts.map +1 -0
  97. package/dist/tools/generated/nginx_one/index.js +1820 -0
  98. package/dist/tools/generated/nginx_one/index.js.map +1 -0
  99. package/dist/tools/generated/object_storage/index.d.ts +8 -0
  100. package/dist/tools/generated/object_storage/index.d.ts.map +1 -0
  101. package/dist/tools/generated/object_storage/index.js +1055 -0
  102. package/dist/tools/generated/object_storage/index.js.map +1 -0
  103. package/dist/tools/generated/observability/index.d.ts.map +1 -1
  104. package/dist/tools/generated/observability/index.js +4243 -4618
  105. package/dist/tools/generated/observability/index.js.map +1 -1
  106. package/dist/tools/generated/rate_limiting/index.d.ts +8 -0
  107. package/dist/tools/generated/rate_limiting/index.d.ts.map +1 -0
  108. package/dist/tools/generated/rate_limiting/index.js +1937 -0
  109. package/dist/tools/generated/rate_limiting/index.js.map +1 -0
  110. package/dist/tools/generated/secops_and_incident_response/index.d.ts +8 -0
  111. package/dist/tools/generated/secops_and_incident_response/index.d.ts.map +1 -0
  112. package/dist/tools/generated/secops_and_incident_response/index.js +653 -0
  113. package/dist/tools/generated/secops_and_incident_response/index.js.map +1 -0
  114. package/dist/tools/generated/service_mesh/index.d.ts.map +1 -1
  115. package/dist/tools/generated/service_mesh/index.js +4532 -438
  116. package/dist/tools/generated/service_mesh/index.js.map +1 -1
  117. package/dist/tools/generated/shape/index.d.ts +8 -0
  118. package/dist/tools/generated/shape/index.d.ts.map +1 -0
  119. package/dist/tools/generated/shape/index.js +21784 -0
  120. package/dist/tools/generated/shape/index.js.map +1 -0
  121. package/dist/tools/generated/sites/index.d.ts +8 -0
  122. package/dist/tools/generated/sites/index.d.ts.map +1 -0
  123. package/dist/tools/generated/sites/index.js +13252 -0
  124. package/dist/tools/generated/sites/index.js.map +1 -0
  125. package/dist/tools/generated/statistics/index.d.ts +8 -0
  126. package/dist/tools/generated/statistics/index.d.ts.map +1 -0
  127. package/dist/tools/generated/statistics/index.js +8837 -0
  128. package/dist/tools/generated/statistics/index.js.map +1 -0
  129. package/dist/tools/generated/support/index.d.ts +8 -0
  130. package/dist/tools/generated/support/index.d.ts.map +1 -0
  131. package/dist/tools/generated/support/index.js +6215 -0
  132. package/dist/tools/generated/support/index.js.map +1 -0
  133. package/dist/tools/generated/telemetry_and_insights/index.d.ts +8 -0
  134. package/dist/tools/generated/telemetry_and_insights/index.d.ts.map +1 -0
  135. package/dist/tools/generated/telemetry_and_insights/index.js +2773 -0
  136. package/dist/tools/generated/telemetry_and_insights/index.js.map +1 -0
  137. package/dist/tools/generated/tenant_and_identity/index.d.ts +8 -0
  138. package/dist/tools/generated/tenant_and_identity/index.d.ts.map +1 -0
  139. package/dist/tools/generated/tenant_and_identity/index.js +20456 -0
  140. package/dist/tools/generated/tenant_and_identity/index.js.map +1 -0
  141. package/dist/tools/generated/threat_campaign/index.d.ts +8 -0
  142. package/dist/tools/generated/threat_campaign/index.d.ts.map +1 -0
  143. package/dist/tools/generated/threat_campaign/index.js +112 -0
  144. package/dist/tools/generated/threat_campaign/index.js.map +1 -0
  145. package/dist/tools/generated/users/index.d.ts +8 -0
  146. package/dist/tools/generated/users/index.d.ts.map +1 -0
  147. package/dist/tools/generated/users/index.js +1572 -0
  148. package/dist/tools/generated/users/index.js.map +1 -0
  149. package/dist/tools/generated/virtual/index.d.ts +8 -0
  150. package/dist/tools/generated/virtual/index.d.ts.map +1 -0
  151. package/dist/tools/generated/virtual/index.js +11540 -0
  152. package/dist/tools/generated/virtual/index.js.map +1 -0
  153. package/dist/tools/generated/vpm_and_node_management/index.d.ts +8 -0
  154. package/dist/tools/generated/vpm_and_node_management/index.d.ts.map +1 -0
  155. package/dist/tools/generated/vpm_and_node_management/index.js +98 -0
  156. package/dist/tools/generated/vpm_and_node_management/index.js.map +1 -0
  157. package/dist/tools/generated/waf/index.d.ts +8 -0
  158. package/dist/tools/generated/waf/index.d.ts.map +1 -0
  159. package/dist/tools/generated/waf/index.js +4440 -0
  160. package/dist/tools/generated/waf/index.js.map +1 -0
  161. package/dist/tools/registry.d.ts.map +1 -1
  162. package/dist/tools/registry.js +68 -36
  163. package/dist/tools/registry.js.map +1 -1
  164. package/package.json +3 -1
  165. package/dist/tools/generated/ai_intelligence/index.d.ts +0 -8
  166. package/dist/tools/generated/ai_intelligence/index.d.ts.map +0 -1
  167. package/dist/tools/generated/ai_intelligence/index.js +0 -282
  168. package/dist/tools/generated/ai_intelligence/index.js.map +0 -1
  169. package/dist/tools/generated/api_security/index.d.ts +0 -8
  170. package/dist/tools/generated/api_security/index.d.ts.map +0 -1
  171. package/dist/tools/generated/api_security/index.js +0 -1852
  172. package/dist/tools/generated/api_security/index.js.map +0 -1
  173. package/dist/tools/generated/applications/index.d.ts +0 -8
  174. package/dist/tools/generated/applications/index.d.ts.map +0 -1
  175. package/dist/tools/generated/applications/index.js +0 -1589
  176. package/dist/tools/generated/applications/index.js.map +0 -1
  177. package/dist/tools/generated/billing/index.d.ts +0 -8
  178. package/dist/tools/generated/billing/index.d.ts.map +0 -1
  179. package/dist/tools/generated/billing/index.js +0 -759
  180. package/dist/tools/generated/billing/index.js.map +0 -1
  181. package/dist/tools/generated/config/index.d.ts +0 -8
  182. package/dist/tools/generated/config/index.d.ts.map +0 -1
  183. package/dist/tools/generated/config/index.js +0 -316
  184. package/dist/tools/generated/config/index.js.map +0 -1
  185. package/dist/tools/generated/identity/index.d.ts +0 -8
  186. package/dist/tools/generated/identity/index.d.ts.map +0 -1
  187. package/dist/tools/generated/identity/index.js +0 -5371
  188. package/dist/tools/generated/identity/index.js.map +0 -1
  189. package/dist/tools/generated/infrastructure/index.d.ts +0 -8
  190. package/dist/tools/generated/infrastructure/index.d.ts.map +0 -1
  191. package/dist/tools/generated/infrastructure/index.js +0 -5342
  192. package/dist/tools/generated/infrastructure/index.js.map +0 -1
  193. package/dist/tools/generated/infrastructure_protection/index.d.ts +0 -8
  194. package/dist/tools/generated/infrastructure_protection/index.d.ts.map +0 -1
  195. package/dist/tools/generated/infrastructure_protection/index.js +0 -2919
  196. package/dist/tools/generated/infrastructure_protection/index.js.map +0 -1
  197. package/dist/tools/generated/integrations/index.d.ts +0 -8
  198. package/dist/tools/generated/integrations/index.d.ts.map +0 -1
  199. package/dist/tools/generated/integrations/index.js +0 -1995
  200. package/dist/tools/generated/integrations/index.js.map +0 -1
  201. package/dist/tools/generated/load_balancer/index.d.ts +0 -8
  202. package/dist/tools/generated/load_balancer/index.d.ts.map +0 -1
  203. package/dist/tools/generated/load_balancer/index.js +0 -2269
  204. package/dist/tools/generated/load_balancer/index.js.map +0 -1
  205. package/dist/tools/generated/networking/index.d.ts +0 -8
  206. package/dist/tools/generated/networking/index.d.ts.map +0 -1
  207. package/dist/tools/generated/networking/index.js +0 -11289
  208. package/dist/tools/generated/networking/index.js.map +0 -1
  209. package/dist/tools/generated/nginx/index.d.ts +0 -8
  210. package/dist/tools/generated/nginx/index.d.ts.map +0 -1
  211. package/dist/tools/generated/nginx/index.js +0 -680
  212. package/dist/tools/generated/nginx/index.js.map +0 -1
  213. package/dist/tools/generated/operations/index.d.ts +0 -8
  214. package/dist/tools/generated/operations/index.d.ts.map +0 -1
  215. package/dist/tools/generated/operations/index.js +0 -1759
  216. package/dist/tools/generated/operations/index.js.map +0 -1
  217. package/dist/tools/generated/security/index.d.ts +0 -8
  218. package/dist/tools/generated/security/index.d.ts.map +0 -1
  219. package/dist/tools/generated/security/index.js +0 -9111
  220. package/dist/tools/generated/security/index.js.map +0 -1
  221. package/dist/tools/generated/shape_security/index.d.ts +0 -8
  222. package/dist/tools/generated/shape_security/index.d.ts.map +0 -1
  223. package/dist/tools/generated/shape_security/index.js +0 -4121
  224. package/dist/tools/generated/shape_security/index.js.map +0 -1
  225. package/dist/tools/generated/subscriptions/index.d.ts +0 -8
  226. package/dist/tools/generated/subscriptions/index.d.ts.map +0 -1
  227. package/dist/tools/generated/subscriptions/index.js +0 -778
  228. package/dist/tools/generated/subscriptions/index.js.map +0 -1
  229. package/dist/tools/generated/tenant_management/index.d.ts +0 -8
  230. package/dist/tools/generated/tenant_management/index.d.ts.map +0 -1
  231. package/dist/tools/generated/tenant_management/index.js +0 -2292
  232. package/dist/tools/generated/tenant_management/index.js.map +0 -1
  233. package/dist/tools/generated/vpn/index.d.ts +0 -8
  234. package/dist/tools/generated/vpn/index.js +0 -1183
  235. package/dist/tools/generated/vpn/index.js.map +0 -1
@@ -0,0 +1,4440 @@
1
+ /**
2
+ * Generated tool definitions for waf domain
3
+ * DO NOT EDIT - This file is auto-generated by scripts/generate.ts
4
+ */
5
+ export const wafTools = [
6
+ {
7
+ toolName: "f5xc-api-waf-active-staged-signature-list",
8
+ method: "GET",
9
+ path: "/api/config/namespaces/{namespace}/virtual_hosts/{vh_name}/active_staged_signatures",
10
+ operation: "list",
11
+ domain: "waf",
12
+ resource: "active-staged-signature",
13
+ summary: "Active Staged Signatures.",
14
+ description: "API to GET active Staged Signatures.",
15
+ pathParameters: [
16
+ {
17
+ description: "Namespace\nFetch WAF signatures changelog for the given namespace.",
18
+ in: "path",
19
+ name: "namespace",
20
+ required: true,
21
+ schema: {
22
+ type: "string",
23
+ },
24
+ "x-displayname": "Namespace",
25
+ "x-ves-example": "Shared",
26
+ },
27
+ {
28
+ description: "Vh_name\nVirtual Host for current request.",
29
+ in: "path",
30
+ name: "vh_name",
31
+ required: true,
32
+ schema: {
33
+ type: "string",
34
+ },
35
+ "x-displayname": "Virtual Host Name.",
36
+ "x-ves-example": "Blogging-app.",
37
+ },
38
+ ],
39
+ queryParameters: [],
40
+ requestBodySchema: null,
41
+ responseSchema: {
42
+ $ref: "#/components/schemas/waf_signatures_changelogReleasedSignaturesRsp",
43
+ },
44
+ requiredParams: ["namespace", "vh_name"],
45
+ operationId: "ves.io.schema.waf_signatures_changelog.WafSignatureChangelogCustomApi.GetActiveStagedSignatures",
46
+ tags: ["Other"],
47
+ sourceFile: "domains/waf.json",
48
+ displayName: null,
49
+ dangerLevel: "low",
50
+ sideEffects: null,
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
+ confirmationRequired: false,
60
+ parameterExamples: {
61
+ namespace: "Shared",
62
+ vh_name: "Blogging-app.",
63
+ },
64
+ validationRules: {},
65
+ operationMetadata: {
66
+ common_errors: [
67
+ {
68
+ code: 401,
69
+ message: "Authentication required",
70
+ solution: "Provide valid API credentials",
71
+ },
72
+ {
73
+ code: 403,
74
+ message: "Permission denied",
75
+ solution: "Check access permissions for this operation",
76
+ },
77
+ {
78
+ code: 404,
79
+ message: "Resource not found",
80
+ solution: "Verify resource name, namespace, and path",
81
+ },
82
+ {
83
+ code: 409,
84
+ message: "Resource already exists",
85
+ solution: "Use different name or update existing resource",
86
+ },
87
+ {
88
+ code: 429,
89
+ message: "Rate limit exceeded",
90
+ solution: "Wait before retrying the operation",
91
+ },
92
+ {
93
+ code: 500,
94
+ message: "Server error",
95
+ solution: "Retry operation or contact support",
96
+ },
97
+ ],
98
+ conditions: {
99
+ postconditions: [],
100
+ prerequisites: ["Active namespace"],
101
+ },
102
+ confirmation_required: false,
103
+ 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
+ field_docs: {},
112
+ optional_fields: [],
113
+ performance_impact: {
114
+ latency: "moderate",
115
+ resource_usage: "moderate",
116
+ },
117
+ purpose: "List all active-staged-signatures",
118
+ required_fields: ["path.namespace", "path.vh_name"],
119
+ side_effects: {},
120
+ },
121
+ },
122
+ {
123
+ toolName: "f5xc-api-waf-aggregation-create",
124
+ method: "POST",
125
+ path: "/api/data/namespaces/system/app_security/all_ns_events/aggregation",
126
+ operation: "create",
127
+ domain: "waf",
128
+ resource: "aggregation",
129
+ summary: "Security Events Aggregation Query All Namespaces.",
130
+ description: "GET summary/aggregation data for security events in the given namespace.\nFor `system` namespace, all security events for the tenant matching the query specified\nin the request will be considered for aggregation. User may query security events that matches various\nfields such as `vh_name`, `sec_event_type`, `src_site`, `city`, `country`.",
131
+ pathParameters: [],
132
+ queryParameters: [],
133
+ requestBodySchema: null,
134
+ responseSchema: {
135
+ $ref: "#/components/schemas/app_securitySecurityEventsAggregationResponse",
136
+ },
137
+ requiredParams: [],
138
+ operationId: "ves.io.schema.app_security.AppSecurityMonitoringAPI.SecurityEventsAggregationQueryAllNamespaces",
139
+ tags: ["Other"],
140
+ sourceFile: "domains/waf.json",
141
+ displayName: null,
142
+ dangerLevel: "medium",
143
+ sideEffects: {
144
+ creates: ["aggregation"],
145
+ },
146
+ 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
+ confirmationRequired: false,
160
+ parameterExamples: {},
161
+ validationRules: {},
162
+ operationMetadata: {
163
+ common_errors: [
164
+ {
165
+ code: 401,
166
+ message: "Authentication required",
167
+ solution: "Provide valid API credentials",
168
+ },
169
+ {
170
+ code: 403,
171
+ message: "Permission denied",
172
+ solution: "Check access permissions for this operation",
173
+ },
174
+ {
175
+ code: 404,
176
+ message: "Resource not found",
177
+ solution: "Verify resource name, namespace, and path",
178
+ },
179
+ {
180
+ code: 409,
181
+ message: "Resource already exists",
182
+ solution: "Use different name or update existing resource",
183
+ },
184
+ {
185
+ code: 429,
186
+ message: "Rate limit exceeded",
187
+ solution: "Wait before retrying the operation",
188
+ },
189
+ {
190
+ code: 500,
191
+ message: "Server error",
192
+ solution: "Retry operation or contact support",
193
+ },
194
+ ],
195
+ conditions: {
196
+ postconditions: ["Aggregation resource created", "Resource assigned unique identifier"],
197
+ prerequisites: ["Active namespace"],
198
+ },
199
+ confirmation_required: false,
200
+ 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
+ field_docs: {},
214
+ optional_fields: [],
215
+ performance_impact: {
216
+ latency: "low",
217
+ resource_usage: "low",
218
+ },
219
+ purpose: "Create new aggregation",
220
+ required_fields: ["metadata.name", "metadata.namespace"],
221
+ side_effects: {
222
+ creates: ["aggregation"],
223
+ },
224
+ },
225
+ },
226
+ {
227
+ toolName: "f5xc-api-waf-all-ns-event-create",
228
+ method: "POST",
229
+ path: "/api/data/namespaces/system/app_security/all_ns_events",
230
+ operation: "create",
231
+ domain: "waf",
232
+ resource: "all-ns-event",
233
+ summary: "Security Events Query All Namespaces.",
234
+ description: "GET security events for the given namespace.\nFor `system` namespace, all security events for the tenant matching the query specified\nin the request will be returned in the response. User may query security events that matches various\nfields such as `vh_name`, `sec_event_type`, `src_site`, `city`, `country`.\nThis API is specific to system namespace.",
235
+ pathParameters: [],
236
+ queryParameters: [],
237
+ requestBodySchema: null,
238
+ responseSchema: {
239
+ $ref: "#/components/schemas/app_securitySecurityEventsResponse",
240
+ },
241
+ requiredParams: [],
242
+ operationId: "ves.io.schema.app_security.AppSecurityMonitoringAPI.SecurityEventsQueryAllNamespaces",
243
+ tags: ["Other"],
244
+ sourceFile: "domains/waf.json",
245
+ displayName: null,
246
+ dangerLevel: "medium",
247
+ sideEffects: {
248
+ creates: ["all-ns-event"],
249
+ },
250
+ 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
+ confirmationRequired: false,
264
+ parameterExamples: {},
265
+ validationRules: {},
266
+ operationMetadata: {
267
+ common_errors: [
268
+ {
269
+ code: 401,
270
+ message: "Authentication required",
271
+ solution: "Provide valid API credentials",
272
+ },
273
+ {
274
+ code: 403,
275
+ message: "Permission denied",
276
+ solution: "Check access permissions for this operation",
277
+ },
278
+ {
279
+ code: 404,
280
+ message: "Resource not found",
281
+ solution: "Verify resource name, namespace, and path",
282
+ },
283
+ {
284
+ code: 409,
285
+ message: "Resource already exists",
286
+ solution: "Use different name or update existing resource",
287
+ },
288
+ {
289
+ code: 429,
290
+ message: "Rate limit exceeded",
291
+ solution: "Wait before retrying the operation",
292
+ },
293
+ {
294
+ code: 500,
295
+ message: "Server error",
296
+ solution: "Retry operation or contact support",
297
+ },
298
+ ],
299
+ conditions: {
300
+ postconditions: ["All-ns-event resource created", "Resource assigned unique identifier"],
301
+ prerequisites: ["Active namespace"],
302
+ },
303
+ confirmation_required: false,
304
+ 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
+ field_docs: {},
318
+ optional_fields: [],
319
+ performance_impact: {
320
+ latency: "low",
321
+ resource_usage: "low",
322
+ },
323
+ purpose: "Create new all-ns-event",
324
+ required_fields: ["metadata.name", "metadata.namespace"],
325
+ side_effects: {
326
+ creates: ["all-ns-event"],
327
+ },
328
+ },
329
+ },
330
+ {
331
+ toolName: "f5xc-api-waf-all-ns-metric-create",
332
+ method: "POST",
333
+ path: "/api/data/namespaces/system/app_firewall/all_ns_metrics",
334
+ operation: "create",
335
+ domain: "waf",
336
+ resource: "all-ns-metric",
337
+ summary: "MetricsAllNamespaces.",
338
+ description: "App Firewall metrics.",
339
+ pathParameters: [],
340
+ queryParameters: [],
341
+ requestBodySchema: null,
342
+ responseSchema: {
343
+ $ref: "#/components/schemas/app_firewallMetricsResponse",
344
+ },
345
+ requiredParams: [],
346
+ operationId: "ves.io.schema.app_firewall.CustomDataAPI.MetricsAllNamespaces",
347
+ tags: ["Security"],
348
+ sourceFile: "domains/waf.json",
349
+ displayName: null,
350
+ dangerLevel: "medium",
351
+ sideEffects: {
352
+ creates: ["all-ns-metric"],
353
+ },
354
+ 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
+ confirmationRequired: false,
368
+ parameterExamples: {},
369
+ validationRules: {},
370
+ operationMetadata: {
371
+ common_errors: [
372
+ {
373
+ code: 401,
374
+ message: "Authentication required",
375
+ solution: "Provide valid API credentials",
376
+ },
377
+ {
378
+ code: 403,
379
+ message: "Permission denied",
380
+ solution: "Check access permissions for this operation",
381
+ },
382
+ {
383
+ code: 404,
384
+ message: "Resource not found",
385
+ solution: "Verify resource name, namespace, and path",
386
+ },
387
+ {
388
+ code: 409,
389
+ message: "Resource already exists",
390
+ solution: "Use different name or update existing resource",
391
+ },
392
+ {
393
+ code: 429,
394
+ message: "Rate limit exceeded",
395
+ solution: "Wait before retrying the operation",
396
+ },
397
+ {
398
+ code: 500,
399
+ message: "Server error",
400
+ solution: "Retry operation or contact support",
401
+ },
402
+ ],
403
+ conditions: {
404
+ postconditions: ["All-ns-metric resource created", "Resource assigned unique identifier"],
405
+ prerequisites: ["Active namespace"],
406
+ },
407
+ confirmation_required: false,
408
+ 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
+ field_docs: {},
422
+ optional_fields: [],
423
+ performance_impact: {
424
+ latency: "low",
425
+ resource_usage: "low",
426
+ },
427
+ purpose: "Create new all-ns-metric",
428
+ required_fields: ["metadata.name", "metadata.namespace"],
429
+ side_effects: {
430
+ creates: ["all-ns-metric"],
431
+ },
432
+ },
433
+ },
434
+ {
435
+ toolName: "f5xc-api-waf-app-firewall-create",
436
+ method: "POST",
437
+ path: "/api/config/namespaces/{metadata.namespace}/app_firewalls",
438
+ operation: "create",
439
+ domain: "waf",
440
+ resource: "app-firewall",
441
+ summary: "Create Application Firewall.",
442
+ description: "Create Application Firewall.",
443
+ pathParameters: [
444
+ {
445
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
446
+ in: "path",
447
+ name: "metadata.namespace",
448
+ required: true,
449
+ schema: {
450
+ type: "string",
451
+ },
452
+ "x-displayname": "Namespace",
453
+ "x-ves-example": "Staging",
454
+ },
455
+ ],
456
+ queryParameters: [],
457
+ requestBodySchema: {
458
+ $ref: "#/components/schemas/app_firewallCreateRequest",
459
+ },
460
+ responseSchema: {
461
+ $ref: "#/components/schemas/app_firewallCreateResponse",
462
+ },
463
+ requiredParams: ["body", "metadata.namespace"],
464
+ operationId: "ves.io.schema.app_firewall.API.Create",
465
+ tags: ["Other"],
466
+ sourceFile: "domains/waf.json",
467
+ displayName: null,
468
+ dangerLevel: "medium",
469
+ sideEffects: {
470
+ creates: ["app-firewall"],
471
+ },
472
+ 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
+ confirmationRequired: false,
486
+ parameterExamples: {
487
+ "metadata.namespace": "Staging",
488
+ },
489
+ validationRules: {},
490
+ operationMetadata: {
491
+ common_errors: [
492
+ {
493
+ code: 401,
494
+ message: "Authentication required",
495
+ solution: "Provide valid API credentials",
496
+ },
497
+ {
498
+ code: 403,
499
+ message: "Permission denied",
500
+ solution: "Check access permissions for this operation",
501
+ },
502
+ {
503
+ code: 404,
504
+ message: "Resource not found",
505
+ solution: "Verify resource name, namespace, and path",
506
+ },
507
+ {
508
+ code: 409,
509
+ message: "Resource already exists",
510
+ solution: "Use different name or update existing resource",
511
+ },
512
+ {
513
+ code: 429,
514
+ message: "Rate limit exceeded",
515
+ solution: "Wait before retrying the operation",
516
+ },
517
+ {
518
+ code: 500,
519
+ message: "Server error",
520
+ solution: "Retry operation or contact support",
521
+ },
522
+ ],
523
+ conditions: {
524
+ postconditions: ["App-firewall resource created", "Resource assigned unique identifier"],
525
+ prerequisites: ["Active namespace"],
526
+ },
527
+ confirmation_required: false,
528
+ 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
+ field_docs: {},
542
+ optional_fields: [],
543
+ performance_impact: {
544
+ latency: "low",
545
+ resource_usage: "low",
546
+ },
547
+ purpose: "Create new app-firewall",
548
+ required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
549
+ side_effects: {
550
+ creates: ["app-firewall"],
551
+ },
552
+ },
553
+ },
554
+ {
555
+ toolName: "f5xc-api-waf-app-firewall-delete",
556
+ method: "DELETE",
557
+ path: "/api/config/namespaces/{namespace}/app_firewalls/{name}",
558
+ operation: "delete",
559
+ domain: "waf",
560
+ resource: "app-firewall",
561
+ summary: "DELETE Application Firewall.",
562
+ description: "DELETE the specified app_firewall.",
563
+ pathParameters: [
564
+ {
565
+ description: "Name\nName of the configuration object.",
566
+ in: "path",
567
+ name: "name",
568
+ required: true,
569
+ schema: {
570
+ type: "string",
571
+ },
572
+ "x-displayname": "Name",
573
+ "x-ves-example": "Name",
574
+ },
575
+ {
576
+ description: "Namespace\nNamespace in which the configuration object is present.",
577
+ in: "path",
578
+ name: "namespace",
579
+ required: true,
580
+ schema: {
581
+ type: "string",
582
+ },
583
+ "x-displayname": "Namespace",
584
+ "x-ves-example": "Ns1",
585
+ },
586
+ ],
587
+ queryParameters: [],
588
+ requestBodySchema: {
589
+ $ref: "#/components/schemas/app_firewallDeleteRequest",
590
+ },
591
+ responseSchema: {},
592
+ requiredParams: ["body", "name", "namespace"],
593
+ operationId: "ves.io.schema.app_firewall.API.Delete",
594
+ tags: ["Other"],
595
+ sourceFile: "domains/waf.json",
596
+ displayName: null,
597
+ dangerLevel: "high",
598
+ sideEffects: {
599
+ deletes: ["app-firewall", "contained_resources"],
600
+ },
601
+ 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
+ confirmationRequired: true,
610
+ parameterExamples: {
611
+ name: "Name",
612
+ namespace: "Ns1",
613
+ },
614
+ validationRules: {},
615
+ operationMetadata: {
616
+ common_errors: [
617
+ {
618
+ code: 401,
619
+ message: "Authentication required",
620
+ solution: "Provide valid API credentials",
621
+ },
622
+ {
623
+ code: 403,
624
+ message: "Permission denied",
625
+ solution: "Check access permissions for this operation",
626
+ },
627
+ {
628
+ code: 404,
629
+ message: "Resource not found",
630
+ solution: "Verify resource name, namespace, and path",
631
+ },
632
+ {
633
+ code: 409,
634
+ message: "Resource already exists",
635
+ solution: "Use different name or update existing resource",
636
+ },
637
+ {
638
+ code: 429,
639
+ message: "Rate limit exceeded",
640
+ solution: "Wait before retrying the operation",
641
+ },
642
+ {
643
+ code: 500,
644
+ message: "Server error",
645
+ solution: "Retry operation or contact support",
646
+ },
647
+ ],
648
+ conditions: {
649
+ postconditions: ["Resource removed from system", "Associated resources may be affected"],
650
+ prerequisites: ["Active namespace"],
651
+ },
652
+ confirmation_required: true,
653
+ 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
+ field_docs: {},
662
+ optional_fields: [],
663
+ performance_impact: {
664
+ latency: "high",
665
+ resource_usage: "moderate",
666
+ },
667
+ purpose: "Delete app-firewall",
668
+ required_fields: ["path.name", "path.namespace"],
669
+ side_effects: {
670
+ deletes: ["app-firewall", "contained_resources"],
671
+ },
672
+ },
673
+ },
674
+ {
675
+ toolName: "f5xc-api-waf-app-firewall-get",
676
+ method: "GET",
677
+ path: "/api/config/namespaces/{namespace}/app_firewalls/{name}",
678
+ operation: "get",
679
+ domain: "waf",
680
+ resource: "app-firewall",
681
+ summary: "GET Application Firewall.",
682
+ description: "GET Application Firewall.",
683
+ pathParameters: [
684
+ {
685
+ description: "Name\nThe name of the configuration object to be fetched.",
686
+ in: "path",
687
+ name: "name",
688
+ required: true,
689
+ schema: {
690
+ type: "string",
691
+ },
692
+ "x-displayname": "Name",
693
+ "x-ves-example": "Name",
694
+ },
695
+ {
696
+ description: "Namespace\nThe namespace in which the configuration object is present.",
697
+ in: "path",
698
+ name: "namespace",
699
+ required: true,
700
+ schema: {
701
+ type: "string",
702
+ },
703
+ "x-displayname": "Namespace",
704
+ "x-ves-example": "Ns1",
705
+ },
706
+ ],
707
+ queryParameters: [
708
+ {
709
+ description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
710
+ in: "query",
711
+ name: "response_format",
712
+ required: false,
713
+ schema: {
714
+ default: "GET_RSP_FORMAT_DEFAULT",
715
+ enum: [
716
+ "GET_RSP_FORMAT_DEFAULT",
717
+ "GET_RSP_FORMAT_FOR_CREATE",
718
+ "GET_RSP_FORMAT_FOR_REPLACE",
719
+ "GET_RSP_FORMAT_STATUS",
720
+ "GET_RSP_FORMAT_READ",
721
+ "GET_RSP_FORMAT_REFERRING_OBJECTS",
722
+ "GET_RSP_FORMAT_BROKEN_REFERENCES",
723
+ ],
724
+ type: "string",
725
+ },
726
+ "x-displayname": "Broken Referred Objects.",
727
+ },
728
+ ],
729
+ requestBodySchema: null,
730
+ responseSchema: {
731
+ $ref: "#/components/schemas/app_firewallGetResponse",
732
+ },
733
+ requiredParams: ["name", "namespace"],
734
+ operationId: "ves.io.schema.app_firewall.API.Get",
735
+ tags: ["Other"],
736
+ sourceFile: "domains/waf.json",
737
+ displayName: null,
738
+ dangerLevel: "low",
739
+ sideEffects: null,
740
+ 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
+ confirmationRequired: false,
749
+ parameterExamples: {
750
+ name: "Name",
751
+ namespace: "Ns1",
752
+ },
753
+ validationRules: {},
754
+ operationMetadata: {
755
+ common_errors: [
756
+ {
757
+ code: 401,
758
+ message: "Authentication required",
759
+ solution: "Provide valid API credentials",
760
+ },
761
+ {
762
+ code: 403,
763
+ message: "Permission denied",
764
+ solution: "Check access permissions for this operation",
765
+ },
766
+ {
767
+ code: 404,
768
+ message: "Resource not found",
769
+ solution: "Verify resource name, namespace, and path",
770
+ },
771
+ {
772
+ code: 409,
773
+ message: "Resource already exists",
774
+ solution: "Use different name or update existing resource",
775
+ },
776
+ {
777
+ code: 429,
778
+ message: "Rate limit exceeded",
779
+ solution: "Wait before retrying the operation",
780
+ },
781
+ {
782
+ code: 500,
783
+ message: "Server error",
784
+ solution: "Retry operation or contact support",
785
+ },
786
+ ],
787
+ conditions: {
788
+ postconditions: [],
789
+ prerequisites: ["Active namespace"],
790
+ },
791
+ confirmation_required: false,
792
+ 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
+ field_docs: {},
801
+ optional_fields: [],
802
+ performance_impact: {
803
+ latency: "low",
804
+ resource_usage: "low",
805
+ },
806
+ purpose: "Retrieve specific app-firewall",
807
+ required_fields: ["path.name", "path.namespace"],
808
+ side_effects: {},
809
+ },
810
+ },
811
+ {
812
+ toolName: "f5xc-api-waf-app-firewall-list",
813
+ method: "GET",
814
+ path: "/api/config/namespaces/{namespace}/app_firewalls",
815
+ operation: "list",
816
+ domain: "waf",
817
+ resource: "app-firewall",
818
+ summary: "List Application Firewall.",
819
+ description: "List the set of app_firewall in a namespace.",
820
+ pathParameters: [
821
+ {
822
+ description: "Namespace\nNamespace to scope the listing of app_firewall.",
823
+ in: "path",
824
+ name: "namespace",
825
+ required: true,
826
+ schema: {
827
+ type: "string",
828
+ },
829
+ "x-displayname": "Namespace",
830
+ "x-ves-example": "Ns1",
831
+ },
832
+ ],
833
+ queryParameters: [
834
+ {
835
+ description: "A LabelSelectorType expression that every item in list response will satisfy.",
836
+ in: "query",
837
+ name: "label_filter",
838
+ required: false,
839
+ schema: {
840
+ type: "string",
841
+ },
842
+ "x-displayname": "Label Filter.",
843
+ "x-ves-example": "Env in (staging, testing), tier in (web, db)",
844
+ },
845
+ {
846
+ description: 'X-example: ""\nExtra fields to return along with summary fields.',
847
+ in: "query",
848
+ name: "report_fields",
849
+ required: false,
850
+ schema: {
851
+ items: {
852
+ type: "string",
853
+ },
854
+ type: "array",
855
+ },
856
+ "x-displayname": "Report Fields.",
857
+ },
858
+ {
859
+ description: 'X-example: ""\nExtra status fields to return along with summary fields.',
860
+ in: "query",
861
+ name: "report_status_fields",
862
+ required: false,
863
+ schema: {
864
+ items: {
865
+ type: "string",
866
+ },
867
+ type: "array",
868
+ },
869
+ "x-displayname": "Report Status Fields.",
870
+ },
871
+ ],
872
+ requestBodySchema: null,
873
+ responseSchema: {
874
+ $ref: "#/components/schemas/app_firewallListResponse",
875
+ },
876
+ requiredParams: ["namespace"],
877
+ operationId: "ves.io.schema.app_firewall.API.List",
878
+ tags: ["Other"],
879
+ sourceFile: "domains/waf.json",
880
+ displayName: null,
881
+ dangerLevel: "low",
882
+ sideEffects: null,
883
+ 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
+ confirmationRequired: false,
892
+ parameterExamples: {
893
+ label_filter: "Env in (staging, testing), tier in (web, db)",
894
+ namespace: "Ns1",
895
+ },
896
+ validationRules: {},
897
+ operationMetadata: {
898
+ common_errors: [
899
+ {
900
+ code: 401,
901
+ message: "Authentication required",
902
+ solution: "Provide valid API credentials",
903
+ },
904
+ {
905
+ code: 403,
906
+ message: "Permission denied",
907
+ solution: "Check access permissions for this operation",
908
+ },
909
+ {
910
+ code: 404,
911
+ message: "Resource not found",
912
+ solution: "Verify resource name, namespace, and path",
913
+ },
914
+ {
915
+ code: 409,
916
+ message: "Resource already exists",
917
+ solution: "Use different name or update existing resource",
918
+ },
919
+ {
920
+ code: 429,
921
+ message: "Rate limit exceeded",
922
+ solution: "Wait before retrying the operation",
923
+ },
924
+ {
925
+ code: 500,
926
+ message: "Server error",
927
+ solution: "Retry operation or contact support",
928
+ },
929
+ ],
930
+ conditions: {
931
+ postconditions: [],
932
+ prerequisites: ["Active namespace"],
933
+ },
934
+ confirmation_required: false,
935
+ 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
+ field_docs: {},
944
+ optional_fields: [],
945
+ performance_impact: {
946
+ latency: "moderate",
947
+ resource_usage: "moderate",
948
+ },
949
+ purpose: "List all app-firewalls",
950
+ required_fields: ["path.namespace"],
951
+ side_effects: {},
952
+ },
953
+ },
954
+ {
955
+ toolName: "f5xc-api-waf-app-firewall-update",
956
+ method: "PUT",
957
+ path: "/api/config/namespaces/{metadata.namespace}/app_firewalls/{metadata.name}",
958
+ operation: "update",
959
+ domain: "waf",
960
+ resource: "app-firewall",
961
+ summary: "Replace Application Firewall.",
962
+ description: "Replace Application Firewall.",
963
+ pathParameters: [
964
+ {
965
+ description: "Name\nThe configuration object to be replaced will be looked up by name.",
966
+ in: "path",
967
+ name: "metadata.name",
968
+ required: true,
969
+ schema: {
970
+ type: "string",
971
+ },
972
+ "x-displayname": "Name",
973
+ "x-ves-example": "Example-corp-web.",
974
+ },
975
+ {
976
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
977
+ in: "path",
978
+ name: "metadata.namespace",
979
+ required: true,
980
+ schema: {
981
+ type: "string",
982
+ },
983
+ "x-displayname": "Namespace",
984
+ "x-ves-example": "Staging",
985
+ },
986
+ ],
987
+ queryParameters: [],
988
+ requestBodySchema: {
989
+ $ref: "#/components/schemas/app_firewallReplaceRequest",
990
+ },
991
+ responseSchema: {
992
+ $ref: "#/components/schemas/app_firewallReplaceResponse",
993
+ },
994
+ requiredParams: ["body", "metadata.name", "metadata.namespace"],
995
+ operationId: "ves.io.schema.app_firewall.API.Replace",
996
+ tags: ["Other"],
997
+ sourceFile: "domains/waf.json",
998
+ displayName: null,
999
+ dangerLevel: "medium",
1000
+ sideEffects: {
1001
+ modifies: ["app-firewall"],
1002
+ },
1003
+ 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
+ confirmationRequired: false,
1012
+ parameterExamples: {
1013
+ "metadata.name": "Example-corp-web.",
1014
+ "metadata.namespace": "Staging",
1015
+ },
1016
+ validationRules: {},
1017
+ operationMetadata: {
1018
+ common_errors: [
1019
+ {
1020
+ code: 401,
1021
+ message: "Authentication required",
1022
+ solution: "Provide valid API credentials",
1023
+ },
1024
+ {
1025
+ code: 403,
1026
+ message: "Permission denied",
1027
+ solution: "Check access permissions for this operation",
1028
+ },
1029
+ {
1030
+ code: 404,
1031
+ message: "Resource not found",
1032
+ solution: "Verify resource name, namespace, and path",
1033
+ },
1034
+ {
1035
+ code: 409,
1036
+ message: "Resource already exists",
1037
+ solution: "Use different name or update existing resource",
1038
+ },
1039
+ {
1040
+ code: 429,
1041
+ message: "Rate limit exceeded",
1042
+ solution: "Wait before retrying the operation",
1043
+ },
1044
+ {
1045
+ code: 500,
1046
+ message: "Server error",
1047
+ solution: "Retry operation or contact support",
1048
+ },
1049
+ ],
1050
+ conditions: {
1051
+ postconditions: ["Resource updated with new values"],
1052
+ prerequisites: ["Active namespace"],
1053
+ },
1054
+ confirmation_required: false,
1055
+ 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
+ field_docs: {},
1064
+ optional_fields: [],
1065
+ performance_impact: {
1066
+ latency: "low",
1067
+ resource_usage: "low",
1068
+ },
1069
+ purpose: "Replace existing app-firewall",
1070
+ required_fields: ["path.metadata.name", "path.metadata.namespace"],
1071
+ side_effects: {
1072
+ modifies: ["app-firewall"],
1073
+ },
1074
+ },
1075
+ },
1076
+ {
1077
+ toolName: "f5xc-api-waf-enhanced-firewall-policy-create",
1078
+ method: "POST",
1079
+ path: "/api/config/namespaces/{metadata.namespace}/enhanced_firewall_policys",
1080
+ operation: "create",
1081
+ domain: "waf",
1082
+ resource: "enhanced-firewall-policy",
1083
+ summary: "Create Enhanced Firewall Policy.",
1084
+ description: "Shape of Enhanced Firewall Policy specification.",
1085
+ pathParameters: [
1086
+ {
1087
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
1088
+ in: "path",
1089
+ name: "metadata.namespace",
1090
+ required: true,
1091
+ schema: {
1092
+ type: "string",
1093
+ },
1094
+ "x-displayname": "Namespace",
1095
+ "x-ves-example": "Staging",
1096
+ },
1097
+ ],
1098
+ queryParameters: [],
1099
+ requestBodySchema: {
1100
+ $ref: "#/components/schemas/enhanced_firewall_policyCreateRequest",
1101
+ },
1102
+ responseSchema: {
1103
+ $ref: "#/components/schemas/enhanced_firewall_policyCreateResponse",
1104
+ },
1105
+ requiredParams: ["body", "metadata.namespace"],
1106
+ operationId: "ves.io.schema.enhanced_firewall_policy.API.Create",
1107
+ tags: ["Other"],
1108
+ sourceFile: "domains/waf.json",
1109
+ displayName: null,
1110
+ dangerLevel: "medium",
1111
+ sideEffects: {
1112
+ creates: ["enhanced-firewall-policy"],
1113
+ },
1114
+ 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
+ confirmationRequired: false,
1128
+ parameterExamples: {
1129
+ "metadata.namespace": "Staging",
1130
+ },
1131
+ validationRules: {},
1132
+ operationMetadata: {
1133
+ common_errors: [
1134
+ {
1135
+ code: 401,
1136
+ message: "Authentication required",
1137
+ solution: "Provide valid API credentials",
1138
+ },
1139
+ {
1140
+ code: 403,
1141
+ message: "Permission denied",
1142
+ solution: "Check access permissions for this operation",
1143
+ },
1144
+ {
1145
+ code: 404,
1146
+ message: "Resource not found",
1147
+ solution: "Verify resource name, namespace, and path",
1148
+ },
1149
+ {
1150
+ code: 409,
1151
+ message: "Resource already exists",
1152
+ solution: "Use different name or update existing resource",
1153
+ },
1154
+ {
1155
+ code: 429,
1156
+ message: "Rate limit exceeded",
1157
+ solution: "Wait before retrying the operation",
1158
+ },
1159
+ {
1160
+ code: 500,
1161
+ message: "Server error",
1162
+ solution: "Retry operation or contact support",
1163
+ },
1164
+ ],
1165
+ conditions: {
1166
+ postconditions: [
1167
+ "Enhanced-firewall-policy resource created",
1168
+ "Resource assigned unique identifier",
1169
+ ],
1170
+ prerequisites: ["Active namespace", "Policy parameters defined"],
1171
+ },
1172
+ confirmation_required: false,
1173
+ 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
+ field_docs: {},
1187
+ optional_fields: [],
1188
+ performance_impact: {
1189
+ latency: "low",
1190
+ resource_usage: "low",
1191
+ },
1192
+ purpose: "Create new enhanced-firewall-policy",
1193
+ required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
1194
+ side_effects: {
1195
+ creates: ["enhanced-firewall-policy"],
1196
+ },
1197
+ },
1198
+ },
1199
+ {
1200
+ toolName: "f5xc-api-waf-enhanced-firewall-policy-delete",
1201
+ method: "DELETE",
1202
+ path: "/api/config/namespaces/{namespace}/enhanced_firewall_policys/{name}",
1203
+ operation: "delete",
1204
+ domain: "waf",
1205
+ resource: "enhanced-firewall-policy",
1206
+ summary: "DELETE Enhanced Firewall Policy.",
1207
+ description: "DELETE the specified enhanced_firewall_policy.",
1208
+ pathParameters: [
1209
+ {
1210
+ description: "Name\nName of the configuration object.",
1211
+ in: "path",
1212
+ name: "name",
1213
+ required: true,
1214
+ schema: {
1215
+ type: "string",
1216
+ },
1217
+ "x-displayname": "Name",
1218
+ "x-ves-example": "Name",
1219
+ },
1220
+ {
1221
+ description: "Namespace\nNamespace in which the configuration object is present.",
1222
+ in: "path",
1223
+ name: "namespace",
1224
+ required: true,
1225
+ schema: {
1226
+ type: "string",
1227
+ },
1228
+ "x-displayname": "Namespace",
1229
+ "x-ves-example": "Ns1",
1230
+ },
1231
+ ],
1232
+ queryParameters: [],
1233
+ requestBodySchema: {
1234
+ $ref: "#/components/schemas/enhanced_firewall_policyDeleteRequest",
1235
+ },
1236
+ responseSchema: {},
1237
+ requiredParams: ["body", "name", "namespace"],
1238
+ operationId: "ves.io.schema.enhanced_firewall_policy.API.Delete",
1239
+ tags: ["Other"],
1240
+ sourceFile: "domains/waf.json",
1241
+ displayName: null,
1242
+ dangerLevel: "high",
1243
+ sideEffects: {
1244
+ deletes: ["enhanced-firewall-policy", "contained_resources"],
1245
+ },
1246
+ 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
+ confirmationRequired: true,
1255
+ parameterExamples: {
1256
+ name: "Name",
1257
+ namespace: "Ns1",
1258
+ },
1259
+ validationRules: {},
1260
+ operationMetadata: {
1261
+ common_errors: [
1262
+ {
1263
+ code: 401,
1264
+ message: "Authentication required",
1265
+ solution: "Provide valid API credentials",
1266
+ },
1267
+ {
1268
+ code: 403,
1269
+ message: "Permission denied",
1270
+ solution: "Check access permissions for this operation",
1271
+ },
1272
+ {
1273
+ code: 404,
1274
+ message: "Resource not found",
1275
+ solution: "Verify resource name, namespace, and path",
1276
+ },
1277
+ {
1278
+ code: 409,
1279
+ message: "Resource already exists",
1280
+ solution: "Use different name or update existing resource",
1281
+ },
1282
+ {
1283
+ code: 429,
1284
+ message: "Rate limit exceeded",
1285
+ solution: "Wait before retrying the operation",
1286
+ },
1287
+ {
1288
+ code: 500,
1289
+ message: "Server error",
1290
+ solution: "Retry operation or contact support",
1291
+ },
1292
+ ],
1293
+ conditions: {
1294
+ postconditions: ["Resource removed from system", "Associated resources may be affected"],
1295
+ prerequisites: ["Active namespace", "Policy parameters defined"],
1296
+ },
1297
+ confirmation_required: true,
1298
+ 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
+ field_docs: {},
1307
+ optional_fields: [],
1308
+ performance_impact: {
1309
+ latency: "high",
1310
+ resource_usage: "moderate",
1311
+ },
1312
+ purpose: "Delete enhanced-firewall-policy",
1313
+ required_fields: ["path.name", "path.namespace"],
1314
+ side_effects: {
1315
+ deletes: ["enhanced-firewall-policy", "contained_resources"],
1316
+ },
1317
+ },
1318
+ },
1319
+ {
1320
+ toolName: "f5xc-api-waf-enhanced-firewall-policy-get",
1321
+ method: "GET",
1322
+ path: "/api/config/namespaces/{namespace}/enhanced_firewall_policys/{name}",
1323
+ operation: "get",
1324
+ domain: "waf",
1325
+ resource: "enhanced-firewall-policy",
1326
+ summary: "GET Enhanced Firewall Policy.",
1327
+ description: "Shape of the Enhanced Firewall Policy specification.",
1328
+ pathParameters: [
1329
+ {
1330
+ description: "Name\nThe name of the configuration object to be fetched.",
1331
+ in: "path",
1332
+ name: "name",
1333
+ required: true,
1334
+ schema: {
1335
+ type: "string",
1336
+ },
1337
+ "x-displayname": "Name",
1338
+ "x-ves-example": "Name",
1339
+ },
1340
+ {
1341
+ description: "Namespace\nThe namespace in which the configuration object is present.",
1342
+ in: "path",
1343
+ name: "namespace",
1344
+ required: true,
1345
+ schema: {
1346
+ type: "string",
1347
+ },
1348
+ "x-displayname": "Namespace",
1349
+ "x-ves-example": "Ns1",
1350
+ },
1351
+ ],
1352
+ queryParameters: [
1353
+ {
1354
+ description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
1355
+ in: "query",
1356
+ name: "response_format",
1357
+ required: false,
1358
+ schema: {
1359
+ default: "GET_RSP_FORMAT_DEFAULT",
1360
+ enum: [
1361
+ "GET_RSP_FORMAT_DEFAULT",
1362
+ "GET_RSP_FORMAT_FOR_CREATE",
1363
+ "GET_RSP_FORMAT_FOR_REPLACE",
1364
+ "GET_RSP_FORMAT_STATUS",
1365
+ "GET_RSP_FORMAT_READ",
1366
+ "GET_RSP_FORMAT_REFERRING_OBJECTS",
1367
+ "GET_RSP_FORMAT_BROKEN_REFERENCES",
1368
+ ],
1369
+ type: "string",
1370
+ },
1371
+ "x-displayname": "Broken Referred Objects.",
1372
+ },
1373
+ ],
1374
+ requestBodySchema: null,
1375
+ responseSchema: {
1376
+ $ref: "#/components/schemas/enhanced_firewall_policyGetResponse",
1377
+ },
1378
+ requiredParams: ["name", "namespace"],
1379
+ operationId: "ves.io.schema.enhanced_firewall_policy.API.Get",
1380
+ tags: ["Other"],
1381
+ sourceFile: "domains/waf.json",
1382
+ displayName: null,
1383
+ dangerLevel: "low",
1384
+ sideEffects: null,
1385
+ 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
+ confirmationRequired: false,
1394
+ parameterExamples: {
1395
+ name: "Name",
1396
+ namespace: "Ns1",
1397
+ },
1398
+ validationRules: {},
1399
+ operationMetadata: {
1400
+ common_errors: [
1401
+ {
1402
+ code: 401,
1403
+ message: "Authentication required",
1404
+ solution: "Provide valid API credentials",
1405
+ },
1406
+ {
1407
+ code: 403,
1408
+ message: "Permission denied",
1409
+ solution: "Check access permissions for this operation",
1410
+ },
1411
+ {
1412
+ code: 404,
1413
+ message: "Resource not found",
1414
+ solution: "Verify resource name, namespace, and path",
1415
+ },
1416
+ {
1417
+ code: 409,
1418
+ message: "Resource already exists",
1419
+ solution: "Use different name or update existing resource",
1420
+ },
1421
+ {
1422
+ code: 429,
1423
+ message: "Rate limit exceeded",
1424
+ solution: "Wait before retrying the operation",
1425
+ },
1426
+ {
1427
+ code: 500,
1428
+ message: "Server error",
1429
+ solution: "Retry operation or contact support",
1430
+ },
1431
+ ],
1432
+ conditions: {
1433
+ postconditions: [],
1434
+ prerequisites: ["Active namespace", "Policy parameters defined"],
1435
+ },
1436
+ confirmation_required: false,
1437
+ 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
+ field_docs: {},
1446
+ optional_fields: [],
1447
+ performance_impact: {
1448
+ latency: "low",
1449
+ resource_usage: "low",
1450
+ },
1451
+ purpose: "Retrieve specific enhanced-firewall-policy",
1452
+ required_fields: ["path.name", "path.namespace"],
1453
+ side_effects: {},
1454
+ },
1455
+ },
1456
+ {
1457
+ toolName: "f5xc-api-waf-enhanced-firewall-policy-list",
1458
+ method: "GET",
1459
+ path: "/api/config/namespaces/{namespace}/enhanced_firewall_policys",
1460
+ operation: "list",
1461
+ domain: "waf",
1462
+ resource: "enhanced-firewall-policy",
1463
+ summary: "List Enhanced Firewall Policy.",
1464
+ description: "List the set of enhanced_firewall_policy in a namespace.",
1465
+ pathParameters: [
1466
+ {
1467
+ description: "Namespace\nNamespace to scope the listing of enhanced_firewall_policy.",
1468
+ in: "path",
1469
+ name: "namespace",
1470
+ required: true,
1471
+ schema: {
1472
+ type: "string",
1473
+ },
1474
+ "x-displayname": "Namespace",
1475
+ "x-ves-example": "Ns1",
1476
+ },
1477
+ ],
1478
+ queryParameters: [
1479
+ {
1480
+ description: "A LabelSelectorType expression that every item in list response will satisfy.",
1481
+ in: "query",
1482
+ name: "label_filter",
1483
+ required: false,
1484
+ schema: {
1485
+ type: "string",
1486
+ },
1487
+ "x-displayname": "Label Filter.",
1488
+ "x-ves-example": "Env in (staging, testing), tier in (web, db)",
1489
+ },
1490
+ {
1491
+ description: 'X-example: ""\nExtra fields to return along with summary fields.',
1492
+ in: "query",
1493
+ name: "report_fields",
1494
+ required: false,
1495
+ schema: {
1496
+ items: {
1497
+ type: "string",
1498
+ },
1499
+ type: "array",
1500
+ },
1501
+ "x-displayname": "Report Fields.",
1502
+ },
1503
+ {
1504
+ description: 'X-example: ""\nExtra status fields to return along with summary fields.',
1505
+ in: "query",
1506
+ name: "report_status_fields",
1507
+ required: false,
1508
+ schema: {
1509
+ items: {
1510
+ type: "string",
1511
+ },
1512
+ type: "array",
1513
+ },
1514
+ "x-displayname": "Report Status Fields.",
1515
+ },
1516
+ ],
1517
+ requestBodySchema: null,
1518
+ responseSchema: {
1519
+ $ref: "#/components/schemas/enhanced_firewall_policyListResponse",
1520
+ },
1521
+ requiredParams: ["namespace"],
1522
+ operationId: "ves.io.schema.enhanced_firewall_policy.API.List",
1523
+ tags: ["Other"],
1524
+ sourceFile: "domains/waf.json",
1525
+ displayName: null,
1526
+ dangerLevel: "low",
1527
+ sideEffects: null,
1528
+ 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
+ confirmationRequired: false,
1537
+ parameterExamples: {
1538
+ label_filter: "Env in (staging, testing), tier in (web, db)",
1539
+ namespace: "Ns1",
1540
+ },
1541
+ validationRules: {},
1542
+ operationMetadata: {
1543
+ common_errors: [
1544
+ {
1545
+ code: 401,
1546
+ message: "Authentication required",
1547
+ solution: "Provide valid API credentials",
1548
+ },
1549
+ {
1550
+ code: 403,
1551
+ message: "Permission denied",
1552
+ solution: "Check access permissions for this operation",
1553
+ },
1554
+ {
1555
+ code: 404,
1556
+ message: "Resource not found",
1557
+ solution: "Verify resource name, namespace, and path",
1558
+ },
1559
+ {
1560
+ code: 409,
1561
+ message: "Resource already exists",
1562
+ solution: "Use different name or update existing resource",
1563
+ },
1564
+ {
1565
+ code: 429,
1566
+ message: "Rate limit exceeded",
1567
+ solution: "Wait before retrying the operation",
1568
+ },
1569
+ {
1570
+ code: 500,
1571
+ message: "Server error",
1572
+ solution: "Retry operation or contact support",
1573
+ },
1574
+ ],
1575
+ conditions: {
1576
+ postconditions: [],
1577
+ prerequisites: ["Active namespace", "Policy parameters defined"],
1578
+ },
1579
+ confirmation_required: false,
1580
+ 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
+ field_docs: {},
1589
+ optional_fields: [],
1590
+ performance_impact: {
1591
+ latency: "moderate",
1592
+ resource_usage: "moderate",
1593
+ },
1594
+ purpose: "List all enhanced-firewall-policys",
1595
+ required_fields: ["path.namespace"],
1596
+ side_effects: {},
1597
+ },
1598
+ },
1599
+ {
1600
+ toolName: "f5xc-api-waf-enhanced-firewall-policy-update",
1601
+ method: "PUT",
1602
+ path: "/api/config/namespaces/{metadata.namespace}/enhanced_firewall_policys/{metadata.name}",
1603
+ operation: "update",
1604
+ domain: "waf",
1605
+ resource: "enhanced-firewall-policy",
1606
+ summary: "Replace Enhanced Firewall Policy.",
1607
+ description: "Shape of Enhanced Firewall Policy replace specification.",
1608
+ pathParameters: [
1609
+ {
1610
+ description: "Name\nThe configuration object to be replaced will be looked up by name.",
1611
+ in: "path",
1612
+ name: "metadata.name",
1613
+ required: true,
1614
+ schema: {
1615
+ type: "string",
1616
+ },
1617
+ "x-displayname": "Name",
1618
+ "x-ves-example": "Example-corp-web.",
1619
+ },
1620
+ {
1621
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
1622
+ in: "path",
1623
+ name: "metadata.namespace",
1624
+ required: true,
1625
+ schema: {
1626
+ type: "string",
1627
+ },
1628
+ "x-displayname": "Namespace",
1629
+ "x-ves-example": "Staging",
1630
+ },
1631
+ ],
1632
+ queryParameters: [],
1633
+ requestBodySchema: {
1634
+ $ref: "#/components/schemas/enhanced_firewall_policyReplaceRequest",
1635
+ },
1636
+ responseSchema: {
1637
+ $ref: "#/components/schemas/enhanced_firewall_policyReplaceResponse",
1638
+ },
1639
+ requiredParams: ["body", "metadata.name", "metadata.namespace"],
1640
+ operationId: "ves.io.schema.enhanced_firewall_policy.API.Replace",
1641
+ tags: ["Other"],
1642
+ sourceFile: "domains/waf.json",
1643
+ displayName: null,
1644
+ dangerLevel: "medium",
1645
+ sideEffects: {
1646
+ modifies: ["enhanced-firewall-policy"],
1647
+ },
1648
+ 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
+ confirmationRequired: false,
1657
+ parameterExamples: {
1658
+ "metadata.name": "Example-corp-web.",
1659
+ "metadata.namespace": "Staging",
1660
+ },
1661
+ validationRules: {},
1662
+ operationMetadata: {
1663
+ common_errors: [
1664
+ {
1665
+ code: 401,
1666
+ message: "Authentication required",
1667
+ solution: "Provide valid API credentials",
1668
+ },
1669
+ {
1670
+ code: 403,
1671
+ message: "Permission denied",
1672
+ solution: "Check access permissions for this operation",
1673
+ },
1674
+ {
1675
+ code: 404,
1676
+ message: "Resource not found",
1677
+ solution: "Verify resource name, namespace, and path",
1678
+ },
1679
+ {
1680
+ code: 409,
1681
+ message: "Resource already exists",
1682
+ solution: "Use different name or update existing resource",
1683
+ },
1684
+ {
1685
+ code: 429,
1686
+ message: "Rate limit exceeded",
1687
+ solution: "Wait before retrying the operation",
1688
+ },
1689
+ {
1690
+ code: 500,
1691
+ message: "Server error",
1692
+ solution: "Retry operation or contact support",
1693
+ },
1694
+ ],
1695
+ conditions: {
1696
+ postconditions: ["Resource updated with new values"],
1697
+ prerequisites: ["Active namespace", "Policy parameters defined"],
1698
+ },
1699
+ confirmation_required: false,
1700
+ 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
+ field_docs: {},
1709
+ optional_fields: [],
1710
+ performance_impact: {
1711
+ latency: "low",
1712
+ resource_usage: "low",
1713
+ },
1714
+ purpose: "Replace existing enhanced-firewall-policy",
1715
+ required_fields: ["path.metadata.name", "path.metadata.namespace"],
1716
+ side_effects: {
1717
+ modifies: ["enhanced-firewall-policy"],
1718
+ },
1719
+ },
1720
+ },
1721
+ {
1722
+ toolName: "f5xc-api-waf-event-create",
1723
+ method: "POST",
1724
+ path: "/api/data/namespaces/{namespace}/app_security/events",
1725
+ operation: "create",
1726
+ domain: "waf",
1727
+ resource: "event",
1728
+ summary: "Security Events Query.",
1729
+ description: "GET security events for the given namespace.\nFor `system` namespace, all security events for the tenant matching the query specified\nin the request will be returned in the response. User may query security events that matches various\nfields such as `vh_name`, `sec_event_type`, `src_site`, `city`, `country`.",
1730
+ pathParameters: [
1731
+ {
1732
+ description: "Namespace\n\nfetch security events for a given namespace.",
1733
+ in: "path",
1734
+ name: "namespace",
1735
+ required: true,
1736
+ schema: {
1737
+ type: "string",
1738
+ },
1739
+ "x-displayname": "Namespace",
1740
+ "x-ves-example": "Bloggin-app-namespace-1.",
1741
+ },
1742
+ ],
1743
+ queryParameters: [],
1744
+ requestBodySchema: null,
1745
+ responseSchema: {
1746
+ $ref: "#/components/schemas/app_securitySecurityEventsResponse",
1747
+ },
1748
+ requiredParams: ["namespace"],
1749
+ operationId: "ves.io.schema.app_security.AppSecurityMonitoringAPI.SecurityEventsQuery",
1750
+ tags: ["Other"],
1751
+ sourceFile: "domains/waf.json",
1752
+ displayName: null,
1753
+ dangerLevel: "medium",
1754
+ sideEffects: {
1755
+ creates: ["event"],
1756
+ },
1757
+ 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
+ confirmationRequired: false,
1771
+ parameterExamples: {
1772
+ namespace: "Bloggin-app-namespace-1.",
1773
+ },
1774
+ validationRules: {},
1775
+ operationMetadata: {
1776
+ common_errors: [
1777
+ {
1778
+ code: 401,
1779
+ message: "Authentication required",
1780
+ solution: "Provide valid API credentials",
1781
+ },
1782
+ {
1783
+ code: 403,
1784
+ message: "Permission denied",
1785
+ solution: "Check access permissions for this operation",
1786
+ },
1787
+ {
1788
+ code: 404,
1789
+ message: "Resource not found",
1790
+ solution: "Verify resource name, namespace, and path",
1791
+ },
1792
+ {
1793
+ code: 409,
1794
+ message: "Resource already exists",
1795
+ solution: "Use different name or update existing resource",
1796
+ },
1797
+ {
1798
+ code: 429,
1799
+ message: "Rate limit exceeded",
1800
+ solution: "Wait before retrying the operation",
1801
+ },
1802
+ {
1803
+ code: 500,
1804
+ message: "Server error",
1805
+ solution: "Retry operation or contact support",
1806
+ },
1807
+ ],
1808
+ conditions: {
1809
+ postconditions: ["Event resource created", "Resource assigned unique identifier"],
1810
+ prerequisites: ["Active namespace"],
1811
+ },
1812
+ confirmation_required: false,
1813
+ 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
+ field_docs: {},
1827
+ optional_fields: [],
1828
+ performance_impact: {
1829
+ latency: "low",
1830
+ resource_usage: "low",
1831
+ },
1832
+ purpose: "Create new event",
1833
+ required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
1834
+ side_effects: {
1835
+ creates: ["event"],
1836
+ },
1837
+ },
1838
+ },
1839
+ {
1840
+ toolName: "f5xc-api-waf-hit-create",
1841
+ method: "POST",
1842
+ path: "/api/data/namespaces/{namespace}/enhanced_firewall_policy/hits",
1843
+ operation: "create",
1844
+ domain: "waf",
1845
+ resource: "hit",
1846
+ summary: "Enhanced Firewall Policy Hits.",
1847
+ description: "GET the counter for Enhanced Firewall Policy hits for a given namespace.",
1848
+ pathParameters: [
1849
+ {
1850
+ description: "Namespace\nNamespace is used to scope Enhanced Firewall Policy hits for the given namespace.",
1851
+ in: "path",
1852
+ name: "namespace",
1853
+ required: true,
1854
+ schema: {
1855
+ type: "string",
1856
+ },
1857
+ "x-displayname": "Namespace",
1858
+ "x-ves-example": "Ns1",
1859
+ },
1860
+ ],
1861
+ queryParameters: [],
1862
+ requestBodySchema: {
1863
+ $ref: "#/components/schemas/enhanced_firewall_policyEnhancedFirewallPolicyHitsRequest",
1864
+ },
1865
+ responseSchema: {
1866
+ $ref: "#/components/schemas/enhanced_firewall_policyEnhancedFirewallPolicyHitsResponse",
1867
+ },
1868
+ requiredParams: ["body", "namespace"],
1869
+ operationId: "ves.io.schema.enhanced_firewall_policy.CustomDataAPI.EnhancedFirewallPolicyHits",
1870
+ tags: ["Other"],
1871
+ sourceFile: "domains/waf.json",
1872
+ displayName: null,
1873
+ dangerLevel: "medium",
1874
+ sideEffects: {
1875
+ creates: ["hit"],
1876
+ },
1877
+ 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
+ confirmationRequired: false,
1891
+ parameterExamples: {
1892
+ namespace: "Ns1",
1893
+ },
1894
+ validationRules: {},
1895
+ operationMetadata: {
1896
+ common_errors: [
1897
+ {
1898
+ code: 401,
1899
+ message: "Authentication required",
1900
+ solution: "Provide valid API credentials",
1901
+ },
1902
+ {
1903
+ code: 403,
1904
+ message: "Permission denied",
1905
+ solution: "Check access permissions for this operation",
1906
+ },
1907
+ {
1908
+ code: 404,
1909
+ message: "Resource not found",
1910
+ solution: "Verify resource name, namespace, and path",
1911
+ },
1912
+ {
1913
+ code: 409,
1914
+ message: "Resource already exists",
1915
+ solution: "Use different name or update existing resource",
1916
+ },
1917
+ {
1918
+ code: 429,
1919
+ message: "Rate limit exceeded",
1920
+ solution: "Wait before retrying the operation",
1921
+ },
1922
+ {
1923
+ code: 500,
1924
+ message: "Server error",
1925
+ solution: "Retry operation or contact support",
1926
+ },
1927
+ ],
1928
+ conditions: {
1929
+ postconditions: ["Hit resource created", "Resource assigned unique identifier"],
1930
+ prerequisites: ["Active namespace", "Policy parameters defined"],
1931
+ },
1932
+ confirmation_required: false,
1933
+ 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
+ field_docs: {},
1947
+ optional_fields: [],
1948
+ performance_impact: {
1949
+ latency: "low",
1950
+ resource_usage: "low",
1951
+ },
1952
+ purpose: "Create new hit",
1953
+ required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
1954
+ side_effects: {
1955
+ creates: ["hit"],
1956
+ },
1957
+ },
1958
+ },
1959
+ {
1960
+ toolName: "f5xc-api-waf-incident-create",
1961
+ method: "POST",
1962
+ path: "/api/data/namespaces/{namespace}/app_security/incidents",
1963
+ operation: "create",
1964
+ domain: "waf",
1965
+ resource: "incident",
1966
+ summary: "Security Incidents Query.",
1967
+ description: "GET security incidents for the given namespace.\nFor `system` namespace, all security incidents for the tenant matching the query specified\nin the request will be returned in the response. User may query security incidents that matches various\nfields such as `vh_name`, `intent`, `city`, `country`.",
1968
+ pathParameters: [
1969
+ {
1970
+ description: "Namespace\nFetch security incidents for a given namespace.",
1971
+ in: "path",
1972
+ name: "namespace",
1973
+ required: true,
1974
+ schema: {
1975
+ type: "string",
1976
+ },
1977
+ "x-displayname": "Namespace",
1978
+ "x-ves-example": "Bloggin-app-namespace-1.",
1979
+ },
1980
+ ],
1981
+ queryParameters: [],
1982
+ requestBodySchema: {
1983
+ $ref: "#/components/schemas/app_securitySecurityIncidentsRequest",
1984
+ },
1985
+ responseSchema: {
1986
+ $ref: "#/components/schemas/app_securitySecurityIncidentsResponse",
1987
+ },
1988
+ requiredParams: ["body", "namespace"],
1989
+ operationId: "ves.io.schema.app_security.AppSecurityMonitoringAPI.SecurityIncidentsQuery",
1990
+ tags: ["Other"],
1991
+ sourceFile: "domains/waf.json",
1992
+ displayName: null,
1993
+ dangerLevel: "medium",
1994
+ sideEffects: {
1995
+ creates: ["incident"],
1996
+ },
1997
+ 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
+ confirmationRequired: false,
2011
+ parameterExamples: {
2012
+ namespace: "Bloggin-app-namespace-1.",
2013
+ },
2014
+ validationRules: {},
2015
+ operationMetadata: {
2016
+ common_errors: [
2017
+ {
2018
+ code: 401,
2019
+ message: "Authentication required",
2020
+ solution: "Provide valid API credentials",
2021
+ },
2022
+ {
2023
+ code: 403,
2024
+ message: "Permission denied",
2025
+ solution: "Check access permissions for this operation",
2026
+ },
2027
+ {
2028
+ code: 404,
2029
+ message: "Resource not found",
2030
+ solution: "Verify resource name, namespace, and path",
2031
+ },
2032
+ {
2033
+ code: 409,
2034
+ message: "Resource already exists",
2035
+ solution: "Use different name or update existing resource",
2036
+ },
2037
+ {
2038
+ code: 429,
2039
+ message: "Rate limit exceeded",
2040
+ solution: "Wait before retrying the operation",
2041
+ },
2042
+ {
2043
+ code: 500,
2044
+ message: "Server error",
2045
+ solution: "Retry operation or contact support",
2046
+ },
2047
+ ],
2048
+ conditions: {
2049
+ postconditions: ["Incident resource created", "Resource assigned unique identifier"],
2050
+ prerequisites: ["Active namespace"],
2051
+ },
2052
+ confirmation_required: false,
2053
+ 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
+ field_docs: {},
2067
+ optional_fields: [],
2068
+ performance_impact: {
2069
+ latency: "low",
2070
+ resource_usage: "low",
2071
+ },
2072
+ purpose: "Create new incident",
2073
+ required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
2074
+ side_effects: {
2075
+ creates: ["incident"],
2076
+ },
2077
+ },
2078
+ },
2079
+ {
2080
+ toolName: "f5xc-api-waf-loadbalancer-create",
2081
+ method: "POST",
2082
+ path: "/api/data/namespaces/system/app_security/all_ns_search/loadbalancers",
2083
+ operation: "create",
2084
+ domain: "waf",
2085
+ resource: "loadbalancer",
2086
+ summary: "Search load balancers All Namespaces.",
2087
+ description: "GET list of virtual hosts matching label filter.",
2088
+ pathParameters: [],
2089
+ queryParameters: [],
2090
+ requestBodySchema: null,
2091
+ responseSchema: {
2092
+ $ref: "#/components/schemas/app_securitySearchLoadBalancersResponse",
2093
+ },
2094
+ requiredParams: [],
2095
+ operationId: "ves.io.schema.app_security.AppSecurityMonitoringAPI.SearchLoadBalancersAllNamespaces",
2096
+ tags: ["Other"],
2097
+ sourceFile: "domains/waf.json",
2098
+ displayName: null,
2099
+ dangerLevel: "medium",
2100
+ sideEffects: {
2101
+ creates: ["loadbalancer"],
2102
+ },
2103
+ 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
+ confirmationRequired: false,
2117
+ parameterExamples: {},
2118
+ validationRules: {},
2119
+ operationMetadata: {
2120
+ common_errors: [
2121
+ {
2122
+ code: 401,
2123
+ message: "Authentication required",
2124
+ solution: "Provide valid API credentials",
2125
+ },
2126
+ {
2127
+ code: 403,
2128
+ message: "Permission denied",
2129
+ solution: "Check access permissions for this operation",
2130
+ },
2131
+ {
2132
+ code: 404,
2133
+ message: "Resource not found",
2134
+ solution: "Verify resource name, namespace, and path",
2135
+ },
2136
+ {
2137
+ code: 409,
2138
+ message: "Resource already exists",
2139
+ solution: "Use different name or update existing resource",
2140
+ },
2141
+ {
2142
+ code: 429,
2143
+ message: "Rate limit exceeded",
2144
+ solution: "Wait before retrying the operation",
2145
+ },
2146
+ {
2147
+ code: 500,
2148
+ message: "Server error",
2149
+ solution: "Retry operation or contact support",
2150
+ },
2151
+ ],
2152
+ conditions: {
2153
+ postconditions: ["Loadbalancer resource created", "Resource assigned unique identifier"],
2154
+ prerequisites: ["Active namespace"],
2155
+ },
2156
+ confirmation_required: false,
2157
+ 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
+ field_docs: {},
2171
+ optional_fields: [],
2172
+ performance_impact: {
2173
+ latency: "low",
2174
+ resource_usage: "low",
2175
+ },
2176
+ purpose: "Create new loadbalancer",
2177
+ required_fields: ["metadata.name", "metadata.namespace"],
2178
+ side_effects: {
2179
+ creates: ["loadbalancer"],
2180
+ },
2181
+ },
2182
+ },
2183
+ {
2184
+ toolName: "f5xc-api-waf-metric-create",
2185
+ method: "POST",
2186
+ path: "/api/data/namespaces/{namespace}/app_firewall/metrics",
2187
+ operation: "create",
2188
+ domain: "waf",
2189
+ resource: "metric",
2190
+ summary: "Metrics",
2191
+ description: "App Firewall metrics.",
2192
+ pathParameters: [
2193
+ {
2194
+ description: "Namespace",
2195
+ in: "path",
2196
+ name: "namespace",
2197
+ required: true,
2198
+ schema: {
2199
+ type: "string",
2200
+ },
2201
+ "x-displayname": "Namespace",
2202
+ "x-ves-example": "System",
2203
+ },
2204
+ ],
2205
+ queryParameters: [],
2206
+ requestBodySchema: null,
2207
+ responseSchema: {
2208
+ $ref: "#/components/schemas/app_firewallMetricsResponse",
2209
+ },
2210
+ requiredParams: ["namespace"],
2211
+ operationId: "ves.io.schema.app_firewall.CustomDataAPI.Metrics",
2212
+ tags: ["Security"],
2213
+ sourceFile: "domains/waf.json",
2214
+ displayName: null,
2215
+ dangerLevel: "medium",
2216
+ sideEffects: {
2217
+ creates: ["metric"],
2218
+ },
2219
+ 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
+ confirmationRequired: false,
2233
+ parameterExamples: {
2234
+ namespace: "System",
2235
+ },
2236
+ validationRules: {},
2237
+ operationMetadata: {
2238
+ common_errors: [
2239
+ {
2240
+ code: 401,
2241
+ message: "Authentication required",
2242
+ solution: "Provide valid API credentials",
2243
+ },
2244
+ {
2245
+ code: 403,
2246
+ message: "Permission denied",
2247
+ solution: "Check access permissions for this operation",
2248
+ },
2249
+ {
2250
+ code: 404,
2251
+ message: "Resource not found",
2252
+ solution: "Verify resource name, namespace, and path",
2253
+ },
2254
+ {
2255
+ code: 409,
2256
+ message: "Resource already exists",
2257
+ solution: "Use different name or update existing resource",
2258
+ },
2259
+ {
2260
+ code: 429,
2261
+ message: "Rate limit exceeded",
2262
+ solution: "Wait before retrying the operation",
2263
+ },
2264
+ {
2265
+ code: 500,
2266
+ message: "Server error",
2267
+ solution: "Retry operation or contact support",
2268
+ },
2269
+ ],
2270
+ conditions: {
2271
+ postconditions: ["Metric resource created", "Resource assigned unique identifier"],
2272
+ prerequisites: ["Active namespace"],
2273
+ },
2274
+ confirmation_required: false,
2275
+ 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
+ field_docs: {},
2289
+ optional_fields: [],
2290
+ performance_impact: {
2291
+ latency: "low",
2292
+ resource_usage: "low",
2293
+ },
2294
+ purpose: "Create new metric",
2295
+ required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
2296
+ side_effects: {
2297
+ creates: ["metric"],
2298
+ },
2299
+ },
2300
+ },
2301
+ {
2302
+ toolName: "f5xc-api-waf-protocol-inspection-create",
2303
+ method: "POST",
2304
+ path: "/api/config/namespaces/{metadata.namespace}/protocol_inspections",
2305
+ operation: "create",
2306
+ domain: "waf",
2307
+ resource: "protocol-inspection",
2308
+ summary: "Create Protocol Inspection.",
2309
+ description: "Create Protocol Inspection Specification in a given namespace. If one already exists it will give an error.",
2310
+ pathParameters: [
2311
+ {
2312
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
2313
+ in: "path",
2314
+ name: "metadata.namespace",
2315
+ required: true,
2316
+ schema: {
2317
+ type: "string",
2318
+ },
2319
+ "x-displayname": "Namespace",
2320
+ "x-ves-example": "Staging",
2321
+ },
2322
+ ],
2323
+ queryParameters: [],
2324
+ requestBodySchema: {
2325
+ $ref: "#/components/schemas/protocol_inspectionCreateRequest",
2326
+ },
2327
+ responseSchema: {
2328
+ $ref: "#/components/schemas/protocol_inspectionCreateResponse",
2329
+ },
2330
+ requiredParams: ["body", "metadata.namespace"],
2331
+ operationId: "ves.io.schema.protocol_inspection.API.Create",
2332
+ tags: ["Other"],
2333
+ sourceFile: "domains/waf.json",
2334
+ displayName: null,
2335
+ dangerLevel: "medium",
2336
+ sideEffects: {
2337
+ creates: ["protocol-inspection"],
2338
+ },
2339
+ 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
+ confirmationRequired: false,
2353
+ parameterExamples: {
2354
+ "metadata.namespace": "Staging",
2355
+ },
2356
+ validationRules: {},
2357
+ operationMetadata: {
2358
+ common_errors: [
2359
+ {
2360
+ code: 401,
2361
+ message: "Authentication required",
2362
+ solution: "Provide valid API credentials",
2363
+ },
2364
+ {
2365
+ code: 403,
2366
+ message: "Permission denied",
2367
+ solution: "Check access permissions for this operation",
2368
+ },
2369
+ {
2370
+ code: 404,
2371
+ message: "Resource not found",
2372
+ solution: "Verify resource name, namespace, and path",
2373
+ },
2374
+ {
2375
+ code: 409,
2376
+ message: "Resource already exists",
2377
+ solution: "Use different name or update existing resource",
2378
+ },
2379
+ {
2380
+ code: 429,
2381
+ message: "Rate limit exceeded",
2382
+ solution: "Wait before retrying the operation",
2383
+ },
2384
+ {
2385
+ code: 500,
2386
+ message: "Server error",
2387
+ solution: "Retry operation or contact support",
2388
+ },
2389
+ ],
2390
+ conditions: {
2391
+ postconditions: [
2392
+ "Protocol-inspection resource created",
2393
+ "Resource assigned unique identifier",
2394
+ ],
2395
+ prerequisites: ["Active namespace"],
2396
+ },
2397
+ confirmation_required: false,
2398
+ 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
+ field_docs: {},
2412
+ optional_fields: [],
2413
+ performance_impact: {
2414
+ latency: "low",
2415
+ resource_usage: "low",
2416
+ },
2417
+ purpose: "Create new protocol-inspection",
2418
+ required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
2419
+ side_effects: {
2420
+ creates: ["protocol-inspection"],
2421
+ },
2422
+ },
2423
+ },
2424
+ {
2425
+ toolName: "f5xc-api-waf-protocol-inspection-delete",
2426
+ method: "DELETE",
2427
+ path: "/api/config/namespaces/{namespace}/protocol_inspections/{name}",
2428
+ operation: "delete",
2429
+ domain: "waf",
2430
+ resource: "protocol-inspection",
2431
+ summary: "DELETE Configure Protocol Inspection.",
2432
+ description: "DELETE the specified protocol_inspection.",
2433
+ pathParameters: [
2434
+ {
2435
+ description: "Name\nName of the configuration object.",
2436
+ in: "path",
2437
+ name: "name",
2438
+ required: true,
2439
+ schema: {
2440
+ type: "string",
2441
+ },
2442
+ "x-displayname": "Name",
2443
+ "x-ves-example": "Name",
2444
+ },
2445
+ {
2446
+ description: "Namespace\nNamespace in which the configuration object is present.",
2447
+ in: "path",
2448
+ name: "namespace",
2449
+ required: true,
2450
+ schema: {
2451
+ type: "string",
2452
+ },
2453
+ "x-displayname": "Namespace",
2454
+ "x-ves-example": "Ns1",
2455
+ },
2456
+ ],
2457
+ queryParameters: [],
2458
+ requestBodySchema: {
2459
+ $ref: "#/components/schemas/protocol_inspectionDeleteRequest",
2460
+ },
2461
+ responseSchema: {},
2462
+ requiredParams: ["body", "name", "namespace"],
2463
+ operationId: "ves.io.schema.protocol_inspection.API.Delete",
2464
+ tags: ["Other"],
2465
+ sourceFile: "domains/waf.json",
2466
+ displayName: null,
2467
+ dangerLevel: "high",
2468
+ sideEffects: {
2469
+ deletes: ["protocol-inspection", "contained_resources"],
2470
+ },
2471
+ 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
+ confirmationRequired: true,
2480
+ parameterExamples: {
2481
+ name: "Name",
2482
+ namespace: "Ns1",
2483
+ },
2484
+ validationRules: {},
2485
+ operationMetadata: {
2486
+ common_errors: [
2487
+ {
2488
+ code: 401,
2489
+ message: "Authentication required",
2490
+ solution: "Provide valid API credentials",
2491
+ },
2492
+ {
2493
+ code: 403,
2494
+ message: "Permission denied",
2495
+ solution: "Check access permissions for this operation",
2496
+ },
2497
+ {
2498
+ code: 404,
2499
+ message: "Resource not found",
2500
+ solution: "Verify resource name, namespace, and path",
2501
+ },
2502
+ {
2503
+ code: 409,
2504
+ message: "Resource already exists",
2505
+ solution: "Use different name or update existing resource",
2506
+ },
2507
+ {
2508
+ code: 429,
2509
+ message: "Rate limit exceeded",
2510
+ solution: "Wait before retrying the operation",
2511
+ },
2512
+ {
2513
+ code: 500,
2514
+ message: "Server error",
2515
+ solution: "Retry operation or contact support",
2516
+ },
2517
+ ],
2518
+ conditions: {
2519
+ postconditions: ["Resource removed from system", "Associated resources may be affected"],
2520
+ prerequisites: ["Active namespace"],
2521
+ },
2522
+ confirmation_required: true,
2523
+ 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
+ field_docs: {},
2532
+ optional_fields: [],
2533
+ performance_impact: {
2534
+ latency: "high",
2535
+ resource_usage: "moderate",
2536
+ },
2537
+ purpose: "Delete protocol-inspection",
2538
+ required_fields: ["path.name", "path.namespace"],
2539
+ side_effects: {
2540
+ deletes: ["protocol-inspection", "contained_resources"],
2541
+ },
2542
+ },
2543
+ },
2544
+ {
2545
+ toolName: "f5xc-api-waf-protocol-inspection-get",
2546
+ method: "GET",
2547
+ path: "/api/config/namespaces/{namespace}/protocol_inspections/{name}",
2548
+ operation: "get",
2549
+ domain: "waf",
2550
+ resource: "protocol-inspection",
2551
+ summary: "GET Protocol Inspection.",
2552
+ description: "GET Protocol Inspection details.",
2553
+ pathParameters: [
2554
+ {
2555
+ description: "Name\nThe name of the configuration object to be fetched.",
2556
+ in: "path",
2557
+ name: "name",
2558
+ required: true,
2559
+ schema: {
2560
+ type: "string",
2561
+ },
2562
+ "x-displayname": "Name",
2563
+ "x-ves-example": "Name",
2564
+ },
2565
+ {
2566
+ description: "Namespace\nThe namespace in which the configuration object is present.",
2567
+ in: "path",
2568
+ name: "namespace",
2569
+ required: true,
2570
+ schema: {
2571
+ type: "string",
2572
+ },
2573
+ "x-displayname": "Namespace",
2574
+ "x-ves-example": "Ns1",
2575
+ },
2576
+ ],
2577
+ queryParameters: [
2578
+ {
2579
+ description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
2580
+ in: "query",
2581
+ name: "response_format",
2582
+ required: false,
2583
+ schema: {
2584
+ default: "GET_RSP_FORMAT_DEFAULT",
2585
+ enum: [
2586
+ "GET_RSP_FORMAT_DEFAULT",
2587
+ "GET_RSP_FORMAT_FOR_CREATE",
2588
+ "GET_RSP_FORMAT_FOR_REPLACE",
2589
+ "GET_RSP_FORMAT_STATUS",
2590
+ "GET_RSP_FORMAT_READ",
2591
+ "GET_RSP_FORMAT_REFERRING_OBJECTS",
2592
+ "GET_RSP_FORMAT_BROKEN_REFERENCES",
2593
+ ],
2594
+ type: "string",
2595
+ },
2596
+ "x-displayname": "Broken Referred Objects.",
2597
+ },
2598
+ ],
2599
+ requestBodySchema: null,
2600
+ responseSchema: {
2601
+ $ref: "#/components/schemas/protocol_inspectionGetResponse",
2602
+ },
2603
+ requiredParams: ["name", "namespace"],
2604
+ operationId: "ves.io.schema.protocol_inspection.API.Get",
2605
+ tags: ["Other"],
2606
+ sourceFile: "domains/waf.json",
2607
+ displayName: null,
2608
+ dangerLevel: "low",
2609
+ sideEffects: null,
2610
+ 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
+ confirmationRequired: false,
2619
+ parameterExamples: {
2620
+ name: "Name",
2621
+ namespace: "Ns1",
2622
+ },
2623
+ validationRules: {},
2624
+ operationMetadata: {
2625
+ common_errors: [
2626
+ {
2627
+ code: 401,
2628
+ message: "Authentication required",
2629
+ solution: "Provide valid API credentials",
2630
+ },
2631
+ {
2632
+ code: 403,
2633
+ message: "Permission denied",
2634
+ solution: "Check access permissions for this operation",
2635
+ },
2636
+ {
2637
+ code: 404,
2638
+ message: "Resource not found",
2639
+ solution: "Verify resource name, namespace, and path",
2640
+ },
2641
+ {
2642
+ code: 409,
2643
+ message: "Resource already exists",
2644
+ solution: "Use different name or update existing resource",
2645
+ },
2646
+ {
2647
+ code: 429,
2648
+ message: "Rate limit exceeded",
2649
+ solution: "Wait before retrying the operation",
2650
+ },
2651
+ {
2652
+ code: 500,
2653
+ message: "Server error",
2654
+ solution: "Retry operation or contact support",
2655
+ },
2656
+ ],
2657
+ conditions: {
2658
+ postconditions: [],
2659
+ prerequisites: ["Active namespace"],
2660
+ },
2661
+ confirmation_required: false,
2662
+ 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
+ field_docs: {},
2671
+ optional_fields: [],
2672
+ performance_impact: {
2673
+ latency: "low",
2674
+ resource_usage: "low",
2675
+ },
2676
+ purpose: "Retrieve specific protocol-inspection",
2677
+ required_fields: ["path.name", "path.namespace"],
2678
+ side_effects: {},
2679
+ },
2680
+ },
2681
+ {
2682
+ toolName: "f5xc-api-waf-protocol-inspection-list",
2683
+ method: "GET",
2684
+ path: "/api/config/namespaces/{namespace}/protocol_inspections",
2685
+ operation: "list",
2686
+ domain: "waf",
2687
+ resource: "protocol-inspection",
2688
+ summary: "List Configure Protocol Inspection.",
2689
+ description: "List the set of protocol_inspection in a namespace.",
2690
+ pathParameters: [
2691
+ {
2692
+ description: "Namespace\nNamespace to scope the listing of protocol_inspection.",
2693
+ in: "path",
2694
+ name: "namespace",
2695
+ required: true,
2696
+ schema: {
2697
+ type: "string",
2698
+ },
2699
+ "x-displayname": "Namespace",
2700
+ "x-ves-example": "Ns1",
2701
+ },
2702
+ ],
2703
+ queryParameters: [
2704
+ {
2705
+ description: "A LabelSelectorType expression that every item in list response will satisfy.",
2706
+ in: "query",
2707
+ name: "label_filter",
2708
+ required: false,
2709
+ schema: {
2710
+ type: "string",
2711
+ },
2712
+ "x-displayname": "Label Filter.",
2713
+ "x-ves-example": "Env in (staging, testing), tier in (web, db)",
2714
+ },
2715
+ {
2716
+ description: 'X-example: ""\nExtra fields to return along with summary fields.',
2717
+ in: "query",
2718
+ name: "report_fields",
2719
+ required: false,
2720
+ schema: {
2721
+ items: {
2722
+ type: "string",
2723
+ },
2724
+ type: "array",
2725
+ },
2726
+ "x-displayname": "Report Fields.",
2727
+ },
2728
+ {
2729
+ description: 'X-example: ""\nExtra status fields to return along with summary fields.',
2730
+ in: "query",
2731
+ name: "report_status_fields",
2732
+ required: false,
2733
+ schema: {
2734
+ items: {
2735
+ type: "string",
2736
+ },
2737
+ type: "array",
2738
+ },
2739
+ "x-displayname": "Report Status Fields.",
2740
+ },
2741
+ ],
2742
+ requestBodySchema: null,
2743
+ responseSchema: {
2744
+ $ref: "#/components/schemas/protocol_inspectionListResponse",
2745
+ },
2746
+ requiredParams: ["namespace"],
2747
+ operationId: "ves.io.schema.protocol_inspection.API.List",
2748
+ tags: ["Other"],
2749
+ sourceFile: "domains/waf.json",
2750
+ displayName: null,
2751
+ dangerLevel: "low",
2752
+ sideEffects: null,
2753
+ 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
+ confirmationRequired: false,
2762
+ parameterExamples: {
2763
+ label_filter: "Env in (staging, testing), tier in (web, db)",
2764
+ namespace: "Ns1",
2765
+ },
2766
+ validationRules: {},
2767
+ operationMetadata: {
2768
+ common_errors: [
2769
+ {
2770
+ code: 401,
2771
+ message: "Authentication required",
2772
+ solution: "Provide valid API credentials",
2773
+ },
2774
+ {
2775
+ code: 403,
2776
+ message: "Permission denied",
2777
+ solution: "Check access permissions for this operation",
2778
+ },
2779
+ {
2780
+ code: 404,
2781
+ message: "Resource not found",
2782
+ solution: "Verify resource name, namespace, and path",
2783
+ },
2784
+ {
2785
+ code: 409,
2786
+ message: "Resource already exists",
2787
+ solution: "Use different name or update existing resource",
2788
+ },
2789
+ {
2790
+ code: 429,
2791
+ message: "Rate limit exceeded",
2792
+ solution: "Wait before retrying the operation",
2793
+ },
2794
+ {
2795
+ code: 500,
2796
+ message: "Server error",
2797
+ solution: "Retry operation or contact support",
2798
+ },
2799
+ ],
2800
+ conditions: {
2801
+ postconditions: [],
2802
+ prerequisites: ["Active namespace"],
2803
+ },
2804
+ confirmation_required: false,
2805
+ 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
+ field_docs: {},
2814
+ optional_fields: [],
2815
+ performance_impact: {
2816
+ latency: "moderate",
2817
+ resource_usage: "moderate",
2818
+ },
2819
+ purpose: "List all protocol-inspections",
2820
+ required_fields: ["path.namespace"],
2821
+ side_effects: {},
2822
+ },
2823
+ },
2824
+ {
2825
+ toolName: "f5xc-api-waf-protocol-inspection-update",
2826
+ method: "PUT",
2827
+ path: "/api/config/namespaces/{metadata.namespace}/protocol_inspections/{metadata.name}",
2828
+ operation: "update",
2829
+ domain: "waf",
2830
+ resource: "protocol-inspection",
2831
+ summary: "Replace Protocol Inspection.",
2832
+ description: "Replace Protocol Inspection specification in a given namespace.",
2833
+ pathParameters: [
2834
+ {
2835
+ description: "Name\nThe configuration object to be replaced will be looked up by name.",
2836
+ in: "path",
2837
+ name: "metadata.name",
2838
+ required: true,
2839
+ schema: {
2840
+ type: "string",
2841
+ },
2842
+ "x-displayname": "Name",
2843
+ "x-ves-example": "Example-corp-web.",
2844
+ },
2845
+ {
2846
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
2847
+ in: "path",
2848
+ name: "metadata.namespace",
2849
+ required: true,
2850
+ schema: {
2851
+ type: "string",
2852
+ },
2853
+ "x-displayname": "Namespace",
2854
+ "x-ves-example": "Staging",
2855
+ },
2856
+ ],
2857
+ queryParameters: [],
2858
+ requestBodySchema: {
2859
+ $ref: "#/components/schemas/protocol_inspectionReplaceRequest",
2860
+ },
2861
+ responseSchema: {
2862
+ $ref: "#/components/schemas/protocol_inspectionReplaceResponse",
2863
+ },
2864
+ requiredParams: ["body", "metadata.name", "metadata.namespace"],
2865
+ operationId: "ves.io.schema.protocol_inspection.API.Replace",
2866
+ tags: ["Other"],
2867
+ sourceFile: "domains/waf.json",
2868
+ displayName: null,
2869
+ dangerLevel: "medium",
2870
+ sideEffects: {
2871
+ modifies: ["protocol-inspection"],
2872
+ },
2873
+ 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
+ confirmationRequired: false,
2882
+ parameterExamples: {
2883
+ "metadata.name": "Example-corp-web.",
2884
+ "metadata.namespace": "Staging",
2885
+ },
2886
+ validationRules: {},
2887
+ operationMetadata: {
2888
+ common_errors: [
2889
+ {
2890
+ code: 401,
2891
+ message: "Authentication required",
2892
+ solution: "Provide valid API credentials",
2893
+ },
2894
+ {
2895
+ code: 403,
2896
+ message: "Permission denied",
2897
+ solution: "Check access permissions for this operation",
2898
+ },
2899
+ {
2900
+ code: 404,
2901
+ message: "Resource not found",
2902
+ solution: "Verify resource name, namespace, and path",
2903
+ },
2904
+ {
2905
+ code: 409,
2906
+ message: "Resource already exists",
2907
+ solution: "Use different name or update existing resource",
2908
+ },
2909
+ {
2910
+ code: 429,
2911
+ message: "Rate limit exceeded",
2912
+ solution: "Wait before retrying the operation",
2913
+ },
2914
+ {
2915
+ code: 500,
2916
+ message: "Server error",
2917
+ solution: "Retry operation or contact support",
2918
+ },
2919
+ ],
2920
+ conditions: {
2921
+ postconditions: ["Resource updated with new values"],
2922
+ prerequisites: ["Active namespace"],
2923
+ },
2924
+ confirmation_required: false,
2925
+ 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
+ field_docs: {},
2934
+ optional_fields: [],
2935
+ performance_impact: {
2936
+ latency: "low",
2937
+ resource_usage: "low",
2938
+ },
2939
+ purpose: "Replace existing protocol-inspection",
2940
+ required_fields: ["path.metadata.name", "path.metadata.namespace"],
2941
+ side_effects: {
2942
+ modifies: ["protocol-inspection"],
2943
+ },
2944
+ },
2945
+ },
2946
+ {
2947
+ toolName: "f5xc-api-waf-released-signature-list",
2948
+ method: "GET",
2949
+ path: "/api/config/namespaces/{namespace}/virtual_hosts/{vh_name}/released_signatures",
2950
+ operation: "list",
2951
+ domain: "waf",
2952
+ resource: "released-signature",
2953
+ summary: "Released Signatures.",
2954
+ description: "API to GET Released Signatures.",
2955
+ pathParameters: [
2956
+ {
2957
+ description: "Namespace\nFetch WAF signatures changelog for the given namespace.",
2958
+ in: "path",
2959
+ name: "namespace",
2960
+ required: true,
2961
+ schema: {
2962
+ type: "string",
2963
+ },
2964
+ "x-displayname": "Namespace",
2965
+ "x-ves-example": "Shared",
2966
+ },
2967
+ {
2968
+ description: "Vh_name\nVirtual Host for current request.",
2969
+ in: "path",
2970
+ name: "vh_name",
2971
+ required: true,
2972
+ schema: {
2973
+ type: "string",
2974
+ },
2975
+ "x-displayname": "Virtual Host Name.",
2976
+ "x-ves-example": "Blogging-app.",
2977
+ },
2978
+ ],
2979
+ queryParameters: [],
2980
+ requestBodySchema: null,
2981
+ responseSchema: {
2982
+ $ref: "#/components/schemas/waf_signatures_changelogReleasedSignaturesRsp",
2983
+ },
2984
+ requiredParams: ["namespace", "vh_name"],
2985
+ operationId: "ves.io.schema.waf_signatures_changelog.WafSignatureChangelogCustomApi.GetReleasedSignatures",
2986
+ tags: ["Other"],
2987
+ sourceFile: "domains/waf.json",
2988
+ displayName: null,
2989
+ dangerLevel: "low",
2990
+ sideEffects: null,
2991
+ 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
+ confirmationRequired: false,
3000
+ parameterExamples: {
3001
+ namespace: "Shared",
3002
+ vh_name: "Blogging-app.",
3003
+ },
3004
+ validationRules: {},
3005
+ operationMetadata: {
3006
+ common_errors: [
3007
+ {
3008
+ code: 401,
3009
+ message: "Authentication required",
3010
+ solution: "Provide valid API credentials",
3011
+ },
3012
+ {
3013
+ code: 403,
3014
+ message: "Permission denied",
3015
+ solution: "Check access permissions for this operation",
3016
+ },
3017
+ {
3018
+ code: 404,
3019
+ message: "Resource not found",
3020
+ solution: "Verify resource name, namespace, and path",
3021
+ },
3022
+ {
3023
+ code: 409,
3024
+ message: "Resource already exists",
3025
+ solution: "Use different name or update existing resource",
3026
+ },
3027
+ {
3028
+ code: 429,
3029
+ message: "Rate limit exceeded",
3030
+ solution: "Wait before retrying the operation",
3031
+ },
3032
+ {
3033
+ code: 500,
3034
+ message: "Server error",
3035
+ solution: "Retry operation or contact support",
3036
+ },
3037
+ ],
3038
+ conditions: {
3039
+ postconditions: [],
3040
+ prerequisites: ["Active namespace"],
3041
+ },
3042
+ confirmation_required: false,
3043
+ 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
+ field_docs: {},
3052
+ optional_fields: [],
3053
+ performance_impact: {
3054
+ latency: "moderate",
3055
+ resource_usage: "moderate",
3056
+ },
3057
+ purpose: "List all released-signatures",
3058
+ required_fields: ["path.namespace", "path.vh_name"],
3059
+ side_effects: {},
3060
+ },
3061
+ },
3062
+ {
3063
+ toolName: "f5xc-api-waf-rule-hit-create",
3064
+ method: "POST",
3065
+ path: "/api/data/namespaces/{namespace}/wafs/metrics/client/rule_hits",
3066
+ operation: "create",
3067
+ domain: "waf",
3068
+ resource: "rule-hit",
3069
+ summary: "Client Rule Hits Metrics.",
3070
+ description: "GET number of rule hits per client for a given namespace.\nThe rule hits counter can be aggregated based on one or more labels listed here.\nNAMESPACE, APP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, RULE_ID, RULE_SEVERITY, RULE_TAG.",
3071
+ pathParameters: [
3072
+ {
3073
+ description: "Namespace\n\nnamespace is used to scope the WAF rule hits for the given namespace.",
3074
+ in: "path",
3075
+ name: "namespace",
3076
+ required: true,
3077
+ schema: {
3078
+ type: "string",
3079
+ },
3080
+ "x-displayname": "Namespace",
3081
+ "x-ves-example": "Bloggin-app-namespace-1.",
3082
+ },
3083
+ ],
3084
+ queryParameters: [],
3085
+ requestBodySchema: null,
3086
+ responseSchema: {
3087
+ $ref: "#/components/schemas/wafRuleHitsCountResponse",
3088
+ },
3089
+ requiredParams: ["namespace"],
3090
+ operationId: "ves.io.schema.waf.WAFMonitoringAPI.ClientRuleHitsMetrics",
3091
+ tags: ["Other"],
3092
+ sourceFile: "domains/waf.json",
3093
+ displayName: null,
3094
+ dangerLevel: "medium",
3095
+ sideEffects: {
3096
+ creates: ["rule-hit"],
3097
+ },
3098
+ 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
+ confirmationRequired: false,
3112
+ parameterExamples: {
3113
+ namespace: "Bloggin-app-namespace-1.",
3114
+ },
3115
+ validationRules: {},
3116
+ operationMetadata: {
3117
+ common_errors: [
3118
+ {
3119
+ code: 401,
3120
+ message: "Authentication required",
3121
+ solution: "Provide valid API credentials",
3122
+ },
3123
+ {
3124
+ code: 403,
3125
+ message: "Permission denied",
3126
+ solution: "Check access permissions for this operation",
3127
+ },
3128
+ {
3129
+ code: 404,
3130
+ message: "Resource not found",
3131
+ solution: "Verify resource name, namespace, and path",
3132
+ },
3133
+ {
3134
+ code: 409,
3135
+ message: "Resource already exists",
3136
+ solution: "Use different name or update existing resource",
3137
+ },
3138
+ {
3139
+ code: 429,
3140
+ message: "Rate limit exceeded",
3141
+ solution: "Wait before retrying the operation",
3142
+ },
3143
+ {
3144
+ code: 500,
3145
+ message: "Server error",
3146
+ solution: "Retry operation or contact support",
3147
+ },
3148
+ ],
3149
+ conditions: {
3150
+ postconditions: ["Rule-hit resource created", "Resource assigned unique identifier"],
3151
+ prerequisites: ["Active namespace", "Policy parameters defined"],
3152
+ },
3153
+ confirmation_required: false,
3154
+ 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
+ field_docs: {},
3168
+ optional_fields: [],
3169
+ performance_impact: {
3170
+ latency: "low",
3171
+ resource_usage: "low",
3172
+ },
3173
+ purpose: "Create new rule-hit",
3174
+ required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
3175
+ side_effects: {
3176
+ creates: ["rule-hit"],
3177
+ },
3178
+ },
3179
+ },
3180
+ {
3181
+ toolName: "f5xc-api-waf-scroll-create",
3182
+ method: "POST",
3183
+ path: "/api/data/namespaces/{namespace}/app_security/events/scroll",
3184
+ operation: "create",
3185
+ domain: "waf",
3186
+ resource: "scroll",
3187
+ summary: "Security Event Scroll Query.",
3188
+ description: 'Scroll request is used to fetch large number of security events in multiple batches with each SecurityEventResponse\ncontaining no more than 500 messages. To scroll through more than 500 or all messages, one can use the\nSecurityEventScrollRequest. Use the scroll_id returned in the SecurityEventResponse to fetch the next batch of security events\nand one can continue this process till the scroll_id returned is "" which indicates no more events to scroll.',
3189
+ pathParameters: [
3190
+ {
3191
+ description: "Namespace\nfetch the WAF security events scoped by namespace.",
3192
+ in: "path",
3193
+ name: "namespace",
3194
+ required: true,
3195
+ schema: {
3196
+ type: "string",
3197
+ },
3198
+ "x-displayname": "Namespace",
3199
+ "x-ves-example": "Bloggin-app-namespace-1.",
3200
+ },
3201
+ ],
3202
+ queryParameters: [],
3203
+ requestBodySchema: {
3204
+ $ref: "#/components/schemas/app_securitySecurityEventsScrollRequest",
3205
+ },
3206
+ responseSchema: {
3207
+ $ref: "#/components/schemas/app_securitySecurityEventsResponse",
3208
+ },
3209
+ requiredParams: ["body", "namespace"],
3210
+ operationId: "docs_cloud_f5_com_0020_public_ves_io_schema_app_security_ves_swagger_ves.io.schema.app_security.AppSecurityMonitoringAPI.SecurityEventsScrollQuery",
3211
+ tags: ["Other"],
3212
+ sourceFile: "domains/waf.json",
3213
+ displayName: null,
3214
+ dangerLevel: "medium",
3215
+ sideEffects: {
3216
+ creates: ["scroll"],
3217
+ },
3218
+ 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
+ confirmationRequired: false,
3232
+ parameterExamples: {
3233
+ namespace: "Bloggin-app-namespace-1.",
3234
+ },
3235
+ validationRules: {},
3236
+ operationMetadata: {
3237
+ common_errors: [
3238
+ {
3239
+ code: 401,
3240
+ message: "Authentication required",
3241
+ solution: "Provide valid API credentials",
3242
+ },
3243
+ {
3244
+ code: 403,
3245
+ message: "Permission denied",
3246
+ solution: "Check access permissions for this operation",
3247
+ },
3248
+ {
3249
+ code: 404,
3250
+ message: "Resource not found",
3251
+ solution: "Verify resource name, namespace, and path",
3252
+ },
3253
+ {
3254
+ code: 409,
3255
+ message: "Resource already exists",
3256
+ solution: "Use different name or update existing resource",
3257
+ },
3258
+ {
3259
+ code: 429,
3260
+ message: "Rate limit exceeded",
3261
+ solution: "Wait before retrying the operation",
3262
+ },
3263
+ {
3264
+ code: 500,
3265
+ message: "Server error",
3266
+ solution: "Retry operation or contact support",
3267
+ },
3268
+ ],
3269
+ conditions: {
3270
+ postconditions: ["Scroll resource created", "Resource assigned unique identifier"],
3271
+ prerequisites: ["Active namespace"],
3272
+ },
3273
+ confirmation_required: false,
3274
+ 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
+ field_docs: {},
3288
+ optional_fields: [],
3289
+ performance_impact: {
3290
+ latency: "low",
3291
+ resource_usage: "low",
3292
+ },
3293
+ purpose: "Create new scroll",
3294
+ required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
3295
+ side_effects: {
3296
+ creates: ["scroll"],
3297
+ },
3298
+ },
3299
+ },
3300
+ {
3301
+ toolName: "f5xc-api-waf-scroll-list",
3302
+ method: "GET",
3303
+ path: "/api/data/namespaces/{namespace}/app_security/events/scroll",
3304
+ operation: "list",
3305
+ domain: "waf",
3306
+ resource: "scroll",
3307
+ summary: "Security Event Scroll Query.",
3308
+ description: 'Scroll request is used to fetch large number of security events in multiple batches with each SecurityEventResponse\ncontaining no more than 500 messages. To scroll through more than 500 or all messages, one can use the\nSecurityEventScrollRequest. Use the scroll_id returned in the SecurityEventResponse to fetch the next batch of security events\nand one can continue this process till the scroll_id returned is "" which indicates no more events to scroll.',
3309
+ pathParameters: [
3310
+ {
3311
+ description: "Namespace\nfetch the WAF security events scoped by namespace.",
3312
+ in: "path",
3313
+ name: "namespace",
3314
+ required: true,
3315
+ schema: {
3316
+ type: "string",
3317
+ },
3318
+ "x-displayname": "Namespace",
3319
+ "x-ves-example": "Bloggin-app-namespace-1.",
3320
+ },
3321
+ ],
3322
+ queryParameters: [
3323
+ {
3324
+ description: "Long Base-64 encoded string which can be used to retrieve next batch of security events.",
3325
+ in: "query",
3326
+ name: "scroll_id",
3327
+ required: false,
3328
+ schema: {
3329
+ type: "string",
3330
+ },
3331
+ "x-displayname": "Scroll ID",
3332
+ "x-ves-example": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==.",
3333
+ },
3334
+ ],
3335
+ requestBodySchema: null,
3336
+ responseSchema: {
3337
+ $ref: "#/components/schemas/app_securitySecurityEventsResponse",
3338
+ },
3339
+ requiredParams: ["namespace"],
3340
+ operationId: "ves.io.schema.app_security.AppSecurityMonitoringAPI.SecurityEventsScrollQuery",
3341
+ tags: ["Other"],
3342
+ sourceFile: "domains/waf.json",
3343
+ displayName: null,
3344
+ dangerLevel: "low",
3345
+ sideEffects: null,
3346
+ 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
+ confirmationRequired: false,
3355
+ parameterExamples: {
3356
+ namespace: "Bloggin-app-namespace-1.",
3357
+ scroll_id: "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==.",
3358
+ },
3359
+ validationRules: {},
3360
+ operationMetadata: {
3361
+ common_errors: [
3362
+ {
3363
+ code: 401,
3364
+ message: "Authentication required",
3365
+ solution: "Provide valid API credentials",
3366
+ },
3367
+ {
3368
+ code: 403,
3369
+ message: "Permission denied",
3370
+ solution: "Check access permissions for this operation",
3371
+ },
3372
+ {
3373
+ code: 404,
3374
+ message: "Resource not found",
3375
+ solution: "Verify resource name, namespace, and path",
3376
+ },
3377
+ {
3378
+ code: 409,
3379
+ message: "Resource already exists",
3380
+ solution: "Use different name or update existing resource",
3381
+ },
3382
+ {
3383
+ code: 429,
3384
+ message: "Rate limit exceeded",
3385
+ solution: "Wait before retrying the operation",
3386
+ },
3387
+ {
3388
+ code: 500,
3389
+ message: "Server error",
3390
+ solution: "Retry operation or contact support",
3391
+ },
3392
+ ],
3393
+ conditions: {
3394
+ postconditions: [],
3395
+ prerequisites: ["Active namespace"],
3396
+ },
3397
+ confirmation_required: false,
3398
+ 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
+ field_docs: {},
3407
+ optional_fields: [],
3408
+ performance_impact: {
3409
+ latency: "moderate",
3410
+ resource_usage: "moderate",
3411
+ },
3412
+ purpose: "List all scrolls",
3413
+ required_fields: ["path.namespace"],
3414
+ side_effects: {},
3415
+ },
3416
+ },
3417
+ {
3418
+ toolName: "f5xc-api-waf-security-event-create",
3419
+ method: "POST",
3420
+ path: "/api/data/namespaces/{namespace}/wafs/metrics/client/security_events",
3421
+ operation: "create",
3422
+ domain: "waf",
3423
+ resource: "security-event",
3424
+ summary: "Client Security Events Metrics.",
3425
+ description: "GET number of security events per client for a given namespace.\nThe security events counter can be aggregated based on one or more labels listed here.\nNAMESPACE, APP_TYPE, VIRTUAL_HOST, SITE, SERVICE, INSTANCE, WAF_INSTANCE_ID, WAF_MODE.",
3426
+ pathParameters: [
3427
+ {
3428
+ description: "Namespace\nnamespace is used to scope the WAF security events for the given namespace.",
3429
+ in: "path",
3430
+ name: "namespace",
3431
+ required: true,
3432
+ schema: {
3433
+ type: "string",
3434
+ },
3435
+ "x-displayname": "Namespace",
3436
+ "x-ves-example": "Bloggin-app-namespace-1.",
3437
+ },
3438
+ ],
3439
+ queryParameters: [],
3440
+ requestBodySchema: null,
3441
+ responseSchema: {
3442
+ $ref: "#/components/schemas/wafSecurityEventsCountResponse",
3443
+ },
3444
+ requiredParams: ["namespace"],
3445
+ operationId: "ves.io.schema.waf.WAFMonitoringAPI.ClientSecurityEventsMetrics",
3446
+ tags: ["Other"],
3447
+ sourceFile: "domains/waf.json",
3448
+ displayName: null,
3449
+ dangerLevel: "medium",
3450
+ sideEffects: {
3451
+ creates: ["security-event"],
3452
+ },
3453
+ 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
+ confirmationRequired: false,
3467
+ parameterExamples: {
3468
+ namespace: "Bloggin-app-namespace-1.",
3469
+ },
3470
+ validationRules: {},
3471
+ operationMetadata: {
3472
+ common_errors: [
3473
+ {
3474
+ code: 401,
3475
+ message: "Authentication required",
3476
+ solution: "Provide valid API credentials",
3477
+ },
3478
+ {
3479
+ code: 403,
3480
+ message: "Permission denied",
3481
+ solution: "Check access permissions for this operation",
3482
+ },
3483
+ {
3484
+ code: 404,
3485
+ message: "Resource not found",
3486
+ solution: "Verify resource name, namespace, and path",
3487
+ },
3488
+ {
3489
+ code: 409,
3490
+ message: "Resource already exists",
3491
+ solution: "Use different name or update existing resource",
3492
+ },
3493
+ {
3494
+ code: 429,
3495
+ message: "Rate limit exceeded",
3496
+ solution: "Wait before retrying the operation",
3497
+ },
3498
+ {
3499
+ code: 500,
3500
+ message: "Server error",
3501
+ solution: "Retry operation or contact support",
3502
+ },
3503
+ ],
3504
+ conditions: {
3505
+ postconditions: ["Security-event resource created", "Resource assigned unique identifier"],
3506
+ prerequisites: ["Active namespace"],
3507
+ },
3508
+ confirmation_required: false,
3509
+ 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
+ field_docs: {},
3523
+ optional_fields: [],
3524
+ performance_impact: {
3525
+ latency: "low",
3526
+ resource_usage: "low",
3527
+ },
3528
+ purpose: "Create new security-event",
3529
+ required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
3530
+ side_effects: {
3531
+ creates: ["security-event"],
3532
+ },
3533
+ },
3534
+ },
3535
+ {
3536
+ toolName: "f5xc-api-waf-staged-signature-create",
3537
+ method: "POST",
3538
+ path: "/api/ml/data/namespaces/{namespace}/virtual_hosts/{vh_name}/staged_signatures",
3539
+ operation: "create",
3540
+ domain: "waf",
3541
+ resource: "staged-signature",
3542
+ summary: "Staged Signatures.",
3543
+ description: "API to GET Staged Signatures.",
3544
+ pathParameters: [
3545
+ {
3546
+ description: "Namespace\nFetch staged signatures for the given namespace.",
3547
+ in: "path",
3548
+ name: "namespace",
3549
+ required: true,
3550
+ schema: {
3551
+ type: "string",
3552
+ },
3553
+ "x-displayname": "Namespace",
3554
+ "x-ves-example": "Shared",
3555
+ },
3556
+ {
3557
+ description: "Vh_name\nVirtual Host for current request.",
3558
+ in: "path",
3559
+ name: "vh_name",
3560
+ required: true,
3561
+ schema: {
3562
+ type: "string",
3563
+ },
3564
+ "x-displayname": "Virtual Host Name.",
3565
+ "x-ves-example": "Blogging-app.",
3566
+ },
3567
+ ],
3568
+ queryParameters: [],
3569
+ requestBodySchema: {
3570
+ $ref: "#/components/schemas/waf_signatures_changelogStagedSignaturesReq",
3571
+ },
3572
+ responseSchema: {
3573
+ $ref: "#/components/schemas/waf_signatures_changelogStagedSignaturesRsp",
3574
+ },
3575
+ requiredParams: ["body", "namespace", "vh_name"],
3576
+ operationId: "ves.io.schema.waf_signatures_changelog.SignatureCustomApi.GetStagedSignatures",
3577
+ tags: ["Other"],
3578
+ sourceFile: "domains/waf.json",
3579
+ displayName: null,
3580
+ dangerLevel: "medium",
3581
+ sideEffects: {
3582
+ creates: ["staged-signature"],
3583
+ },
3584
+ 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
+ confirmationRequired: false,
3598
+ parameterExamples: {
3599
+ namespace: "Shared",
3600
+ vh_name: "Blogging-app.",
3601
+ },
3602
+ validationRules: {},
3603
+ operationMetadata: {
3604
+ common_errors: [
3605
+ {
3606
+ code: 401,
3607
+ message: "Authentication required",
3608
+ solution: "Provide valid API credentials",
3609
+ },
3610
+ {
3611
+ code: 403,
3612
+ message: "Permission denied",
3613
+ solution: "Check access permissions for this operation",
3614
+ },
3615
+ {
3616
+ code: 404,
3617
+ message: "Resource not found",
3618
+ solution: "Verify resource name, namespace, and path",
3619
+ },
3620
+ {
3621
+ code: 409,
3622
+ message: "Resource already exists",
3623
+ solution: "Use different name or update existing resource",
3624
+ },
3625
+ {
3626
+ code: 429,
3627
+ message: "Rate limit exceeded",
3628
+ solution: "Wait before retrying the operation",
3629
+ },
3630
+ {
3631
+ code: 500,
3632
+ message: "Server error",
3633
+ solution: "Retry operation or contact support",
3634
+ },
3635
+ ],
3636
+ conditions: {
3637
+ postconditions: [
3638
+ "Staged-signature resource created",
3639
+ "Resource assigned unique identifier",
3640
+ ],
3641
+ prerequisites: ["Active namespace"],
3642
+ },
3643
+ confirmation_required: false,
3644
+ 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
+ field_docs: {},
3658
+ optional_fields: [],
3659
+ performance_impact: {
3660
+ latency: "low",
3661
+ resource_usage: "low",
3662
+ },
3663
+ purpose: "Create new staged-signature",
3664
+ required_fields: ["metadata.name", "metadata.namespace", "path.namespace", "path.vh_name"],
3665
+ side_effects: {
3666
+ creates: ["staged-signature"],
3667
+ },
3668
+ },
3669
+ },
3670
+ {
3671
+ toolName: "f5xc-api-waf-suspicious-user-log-create",
3672
+ method: "POST",
3673
+ path: "/api/data/namespaces/{namespace}/app_security/suspicious_user_logs",
3674
+ operation: "create",
3675
+ domain: "waf",
3676
+ resource: "suspicious-user-log",
3677
+ summary: "Suspicious User Logs Query.",
3678
+ description: "GET suspicious user logs for the given namespace.\nFor `system` namespace, all suspicious users logs for the tenant matching the query specified\nin the request will be returned in the response. User may query suspicious user logs that matches various\nfields such as `vh_name`, `user`, `site`, `city`, `country`.",
3679
+ pathParameters: [
3680
+ {
3681
+ description: "Namespace\n\nfetch suspicious user logs for a given namespace.",
3682
+ in: "path",
3683
+ name: "namespace",
3684
+ required: true,
3685
+ schema: {
3686
+ type: "string",
3687
+ },
3688
+ "x-displayname": "Namespace",
3689
+ "x-ves-example": "Bloggin-app-namespace-1.",
3690
+ },
3691
+ ],
3692
+ queryParameters: [],
3693
+ requestBodySchema: {
3694
+ $ref: "#/components/schemas/app_securitySuspiciousUserLogsRequest",
3695
+ },
3696
+ responseSchema: {
3697
+ $ref: "#/components/schemas/app_securitySuspiciousUserLogsResponse",
3698
+ },
3699
+ requiredParams: ["body", "namespace"],
3700
+ operationId: "ves.io.schema.app_security.AppSecurityMonitoringAPI.SuspiciousUserLogsQuery",
3701
+ tags: ["Other"],
3702
+ sourceFile: "domains/waf.json",
3703
+ displayName: null,
3704
+ dangerLevel: "medium",
3705
+ sideEffects: {
3706
+ creates: ["suspicious-user-log"],
3707
+ },
3708
+ 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
+ confirmationRequired: false,
3722
+ parameterExamples: {
3723
+ namespace: "Bloggin-app-namespace-1.",
3724
+ },
3725
+ validationRules: {},
3726
+ operationMetadata: {
3727
+ common_errors: [
3728
+ {
3729
+ code: 401,
3730
+ message: "Authentication required",
3731
+ solution: "Provide valid API credentials",
3732
+ },
3733
+ {
3734
+ code: 403,
3735
+ message: "Permission denied",
3736
+ solution: "Check access permissions for this operation",
3737
+ },
3738
+ {
3739
+ code: 404,
3740
+ message: "Resource not found",
3741
+ solution: "Verify resource name, namespace, and path",
3742
+ },
3743
+ {
3744
+ code: 409,
3745
+ message: "Resource already exists",
3746
+ solution: "Use different name or update existing resource",
3747
+ },
3748
+ {
3749
+ code: 429,
3750
+ message: "Rate limit exceeded",
3751
+ solution: "Wait before retrying the operation",
3752
+ },
3753
+ {
3754
+ code: 500,
3755
+ message: "Server error",
3756
+ solution: "Retry operation or contact support",
3757
+ },
3758
+ ],
3759
+ conditions: {
3760
+ postconditions: [
3761
+ "Suspicious-user-log resource created",
3762
+ "Resource assigned unique identifier",
3763
+ ],
3764
+ prerequisites: ["Active namespace"],
3765
+ },
3766
+ confirmation_required: false,
3767
+ 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
+ field_docs: {},
3781
+ optional_fields: [],
3782
+ performance_impact: {
3783
+ latency: "low",
3784
+ resource_usage: "low",
3785
+ },
3786
+ purpose: "Create new suspicious-user-log",
3787
+ required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
3788
+ side_effects: {
3789
+ creates: ["suspicious-user-log"],
3790
+ },
3791
+ },
3792
+ },
3793
+ {
3794
+ toolName: "f5xc-api-waf-waf-exclusion-policy-create",
3795
+ method: "POST",
3796
+ path: "/api/config/namespaces/{metadata.namespace}/waf_exclusion_policys",
3797
+ operation: "create",
3798
+ domain: "waf",
3799
+ resource: "waf-exclusion-policy",
3800
+ summary: "Create WAF Exclusion Policy.",
3801
+ description: "Create a WAF exclusion policy.",
3802
+ pathParameters: [
3803
+ {
3804
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
3805
+ in: "path",
3806
+ name: "metadata.namespace",
3807
+ required: true,
3808
+ schema: {
3809
+ type: "string",
3810
+ },
3811
+ "x-displayname": "Namespace",
3812
+ "x-ves-example": "Staging",
3813
+ },
3814
+ ],
3815
+ queryParameters: [],
3816
+ requestBodySchema: {
3817
+ $ref: "#/components/schemas/waf_exclusion_policyCreateRequest",
3818
+ },
3819
+ responseSchema: {
3820
+ $ref: "#/components/schemas/waf_exclusion_policyCreateResponse",
3821
+ },
3822
+ requiredParams: ["body", "metadata.namespace"],
3823
+ operationId: "ves.io.schema.waf_exclusion_policy.API.Create",
3824
+ tags: ["Other"],
3825
+ sourceFile: "domains/waf.json",
3826
+ displayName: null,
3827
+ dangerLevel: "medium",
3828
+ sideEffects: {
3829
+ creates: ["waf-exclusion-policy"],
3830
+ },
3831
+ 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
+ confirmationRequired: false,
3845
+ parameterExamples: {
3846
+ "metadata.namespace": "Staging",
3847
+ },
3848
+ validationRules: {},
3849
+ operationMetadata: {
3850
+ common_errors: [
3851
+ {
3852
+ code: 401,
3853
+ message: "Authentication required",
3854
+ solution: "Provide valid API credentials",
3855
+ },
3856
+ {
3857
+ code: 403,
3858
+ message: "Permission denied",
3859
+ solution: "Check access permissions for this operation",
3860
+ },
3861
+ {
3862
+ code: 404,
3863
+ message: "Resource not found",
3864
+ solution: "Verify resource name, namespace, and path",
3865
+ },
3866
+ {
3867
+ code: 409,
3868
+ message: "Resource already exists",
3869
+ solution: "Use different name or update existing resource",
3870
+ },
3871
+ {
3872
+ code: 429,
3873
+ message: "Rate limit exceeded",
3874
+ solution: "Wait before retrying the operation",
3875
+ },
3876
+ {
3877
+ code: 500,
3878
+ message: "Server error",
3879
+ solution: "Retry operation or contact support",
3880
+ },
3881
+ ],
3882
+ conditions: {
3883
+ postconditions: [
3884
+ "Waf-exclusion-policy resource created",
3885
+ "Resource assigned unique identifier",
3886
+ ],
3887
+ prerequisites: ["Active namespace", "Policy parameters defined"],
3888
+ },
3889
+ confirmation_required: false,
3890
+ 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
+ field_docs: {},
3904
+ optional_fields: [],
3905
+ performance_impact: {
3906
+ latency: "low",
3907
+ resource_usage: "low",
3908
+ },
3909
+ purpose: "Create new waf-exclusion-policy",
3910
+ required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
3911
+ side_effects: {
3912
+ creates: ["waf-exclusion-policy"],
3913
+ },
3914
+ },
3915
+ },
3916
+ {
3917
+ toolName: "f5xc-api-waf-waf-exclusion-policy-delete",
3918
+ method: "DELETE",
3919
+ path: "/api/config/namespaces/{namespace}/waf_exclusion_policys/{name}",
3920
+ operation: "delete",
3921
+ domain: "waf",
3922
+ resource: "waf-exclusion-policy",
3923
+ summary: "DELETE WAF Exclusion Policy.",
3924
+ description: "DELETE the specified waf_exclusion_policy.",
3925
+ pathParameters: [
3926
+ {
3927
+ description: "Name\nName of the configuration object.",
3928
+ in: "path",
3929
+ name: "name",
3930
+ required: true,
3931
+ schema: {
3932
+ type: "string",
3933
+ },
3934
+ "x-displayname": "Name",
3935
+ "x-ves-example": "Name",
3936
+ },
3937
+ {
3938
+ description: "Namespace\nNamespace in which the configuration object is present.",
3939
+ in: "path",
3940
+ name: "namespace",
3941
+ required: true,
3942
+ schema: {
3943
+ type: "string",
3944
+ },
3945
+ "x-displayname": "Namespace",
3946
+ "x-ves-example": "Ns1",
3947
+ },
3948
+ ],
3949
+ queryParameters: [],
3950
+ requestBodySchema: {
3951
+ $ref: "#/components/schemas/waf_exclusion_policyDeleteRequest",
3952
+ },
3953
+ responseSchema: {},
3954
+ requiredParams: ["body", "name", "namespace"],
3955
+ operationId: "ves.io.schema.waf_exclusion_policy.API.Delete",
3956
+ tags: ["Other"],
3957
+ sourceFile: "domains/waf.json",
3958
+ displayName: null,
3959
+ dangerLevel: "high",
3960
+ sideEffects: {
3961
+ deletes: ["waf-exclusion-policy", "contained_resources"],
3962
+ },
3963
+ 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
+ confirmationRequired: true,
3972
+ parameterExamples: {
3973
+ name: "Name",
3974
+ namespace: "Ns1",
3975
+ },
3976
+ validationRules: {},
3977
+ operationMetadata: {
3978
+ common_errors: [
3979
+ {
3980
+ code: 401,
3981
+ message: "Authentication required",
3982
+ solution: "Provide valid API credentials",
3983
+ },
3984
+ {
3985
+ code: 403,
3986
+ message: "Permission denied",
3987
+ solution: "Check access permissions for this operation",
3988
+ },
3989
+ {
3990
+ code: 404,
3991
+ message: "Resource not found",
3992
+ solution: "Verify resource name, namespace, and path",
3993
+ },
3994
+ {
3995
+ code: 409,
3996
+ message: "Resource already exists",
3997
+ solution: "Use different name or update existing resource",
3998
+ },
3999
+ {
4000
+ code: 429,
4001
+ message: "Rate limit exceeded",
4002
+ solution: "Wait before retrying the operation",
4003
+ },
4004
+ {
4005
+ code: 500,
4006
+ message: "Server error",
4007
+ solution: "Retry operation or contact support",
4008
+ },
4009
+ ],
4010
+ conditions: {
4011
+ postconditions: ["Resource removed from system", "Associated resources may be affected"],
4012
+ prerequisites: ["Active namespace", "Policy parameters defined"],
4013
+ },
4014
+ confirmation_required: true,
4015
+ 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
+ field_docs: {},
4024
+ optional_fields: [],
4025
+ performance_impact: {
4026
+ latency: "high",
4027
+ resource_usage: "moderate",
4028
+ },
4029
+ purpose: "Delete waf-exclusion-policy",
4030
+ required_fields: ["path.name", "path.namespace"],
4031
+ side_effects: {
4032
+ deletes: ["waf-exclusion-policy", "contained_resources"],
4033
+ },
4034
+ },
4035
+ },
4036
+ {
4037
+ toolName: "f5xc-api-waf-waf-exclusion-policy-get",
4038
+ method: "GET",
4039
+ path: "/api/config/namespaces/{namespace}/waf_exclusion_policys/{name}",
4040
+ operation: "get",
4041
+ domain: "waf",
4042
+ resource: "waf-exclusion-policy",
4043
+ summary: "GET WAF Exclusion Policy.",
4044
+ description: "Retrieve a WAF exclusion policy.",
4045
+ pathParameters: [
4046
+ {
4047
+ description: "Name\nThe name of the configuration object to be fetched.",
4048
+ in: "path",
4049
+ name: "name",
4050
+ required: true,
4051
+ schema: {
4052
+ type: "string",
4053
+ },
4054
+ "x-displayname": "Name",
4055
+ "x-ves-example": "Name",
4056
+ },
4057
+ {
4058
+ description: "Namespace\nThe namespace in which the configuration object is present.",
4059
+ in: "path",
4060
+ name: "namespace",
4061
+ required: true,
4062
+ schema: {
4063
+ type: "string",
4064
+ },
4065
+ "x-displayname": "Namespace",
4066
+ "x-ves-example": "Ns1",
4067
+ },
4068
+ ],
4069
+ queryParameters: [
4070
+ {
4071
+ description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
4072
+ in: "query",
4073
+ name: "response_format",
4074
+ required: false,
4075
+ schema: {
4076
+ default: "GET_RSP_FORMAT_DEFAULT",
4077
+ enum: [
4078
+ "GET_RSP_FORMAT_DEFAULT",
4079
+ "GET_RSP_FORMAT_FOR_CREATE",
4080
+ "GET_RSP_FORMAT_FOR_REPLACE",
4081
+ "GET_RSP_FORMAT_STATUS",
4082
+ "GET_RSP_FORMAT_READ",
4083
+ "GET_RSP_FORMAT_REFERRING_OBJECTS",
4084
+ "GET_RSP_FORMAT_BROKEN_REFERENCES",
4085
+ ],
4086
+ type: "string",
4087
+ },
4088
+ "x-displayname": "Broken Referred Objects.",
4089
+ },
4090
+ ],
4091
+ requestBodySchema: null,
4092
+ responseSchema: {
4093
+ $ref: "#/components/schemas/waf_exclusion_policyGetResponse",
4094
+ },
4095
+ requiredParams: ["name", "namespace"],
4096
+ operationId: "ves.io.schema.waf_exclusion_policy.API.Get",
4097
+ tags: ["Other"],
4098
+ sourceFile: "domains/waf.json",
4099
+ displayName: null,
4100
+ dangerLevel: "low",
4101
+ sideEffects: null,
4102
+ 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
+ confirmationRequired: false,
4111
+ parameterExamples: {
4112
+ name: "Name",
4113
+ namespace: "Ns1",
4114
+ },
4115
+ validationRules: {},
4116
+ operationMetadata: {
4117
+ common_errors: [
4118
+ {
4119
+ code: 401,
4120
+ message: "Authentication required",
4121
+ solution: "Provide valid API credentials",
4122
+ },
4123
+ {
4124
+ code: 403,
4125
+ message: "Permission denied",
4126
+ solution: "Check access permissions for this operation",
4127
+ },
4128
+ {
4129
+ code: 404,
4130
+ message: "Resource not found",
4131
+ solution: "Verify resource name, namespace, and path",
4132
+ },
4133
+ {
4134
+ code: 409,
4135
+ message: "Resource already exists",
4136
+ solution: "Use different name or update existing resource",
4137
+ },
4138
+ {
4139
+ code: 429,
4140
+ message: "Rate limit exceeded",
4141
+ solution: "Wait before retrying the operation",
4142
+ },
4143
+ {
4144
+ code: 500,
4145
+ message: "Server error",
4146
+ solution: "Retry operation or contact support",
4147
+ },
4148
+ ],
4149
+ conditions: {
4150
+ postconditions: [],
4151
+ prerequisites: ["Active namespace", "Policy parameters defined"],
4152
+ },
4153
+ confirmation_required: false,
4154
+ 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
+ field_docs: {},
4163
+ optional_fields: [],
4164
+ performance_impact: {
4165
+ latency: "low",
4166
+ resource_usage: "low",
4167
+ },
4168
+ purpose: "Retrieve specific waf-exclusion-policy",
4169
+ required_fields: ["path.name", "path.namespace"],
4170
+ side_effects: {},
4171
+ },
4172
+ },
4173
+ {
4174
+ toolName: "f5xc-api-waf-waf-exclusion-policy-list",
4175
+ method: "GET",
4176
+ path: "/api/config/namespaces/{namespace}/waf_exclusion_policys",
4177
+ operation: "list",
4178
+ domain: "waf",
4179
+ resource: "waf-exclusion-policy",
4180
+ summary: "List WAF Exclusion Policy.",
4181
+ description: "List the set of waf_exclusion_policy in a namespace.",
4182
+ pathParameters: [
4183
+ {
4184
+ description: "Namespace\nNamespace to scope the listing of waf_exclusion_policy.",
4185
+ in: "path",
4186
+ name: "namespace",
4187
+ required: true,
4188
+ schema: {
4189
+ type: "string",
4190
+ },
4191
+ "x-displayname": "Namespace",
4192
+ "x-ves-example": "Ns1",
4193
+ },
4194
+ ],
4195
+ queryParameters: [
4196
+ {
4197
+ description: "A LabelSelectorType expression that every item in list response will satisfy.",
4198
+ in: "query",
4199
+ name: "label_filter",
4200
+ required: false,
4201
+ schema: {
4202
+ type: "string",
4203
+ },
4204
+ "x-displayname": "Label Filter.",
4205
+ "x-ves-example": "Env in (staging, testing), tier in (web, db)",
4206
+ },
4207
+ {
4208
+ description: 'X-example: ""\nExtra fields to return along with summary fields.',
4209
+ in: "query",
4210
+ name: "report_fields",
4211
+ required: false,
4212
+ schema: {
4213
+ items: {
4214
+ type: "string",
4215
+ },
4216
+ type: "array",
4217
+ },
4218
+ "x-displayname": "Report Fields.",
4219
+ },
4220
+ {
4221
+ description: 'X-example: ""\nExtra status fields to return along with summary fields.',
4222
+ in: "query",
4223
+ name: "report_status_fields",
4224
+ required: false,
4225
+ schema: {
4226
+ items: {
4227
+ type: "string",
4228
+ },
4229
+ type: "array",
4230
+ },
4231
+ "x-displayname": "Report Status Fields.",
4232
+ },
4233
+ ],
4234
+ requestBodySchema: null,
4235
+ responseSchema: {
4236
+ $ref: "#/components/schemas/waf_exclusion_policyListResponse",
4237
+ },
4238
+ requiredParams: ["namespace"],
4239
+ operationId: "ves.io.schema.waf_exclusion_policy.API.List",
4240
+ tags: ["Other"],
4241
+ sourceFile: "domains/waf.json",
4242
+ displayName: null,
4243
+ dangerLevel: "low",
4244
+ sideEffects: null,
4245
+ 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
+ confirmationRequired: false,
4254
+ parameterExamples: {
4255
+ label_filter: "Env in (staging, testing), tier in (web, db)",
4256
+ namespace: "Ns1",
4257
+ },
4258
+ validationRules: {},
4259
+ operationMetadata: {
4260
+ common_errors: [
4261
+ {
4262
+ code: 401,
4263
+ message: "Authentication required",
4264
+ solution: "Provide valid API credentials",
4265
+ },
4266
+ {
4267
+ code: 403,
4268
+ message: "Permission denied",
4269
+ solution: "Check access permissions for this operation",
4270
+ },
4271
+ {
4272
+ code: 404,
4273
+ message: "Resource not found",
4274
+ solution: "Verify resource name, namespace, and path",
4275
+ },
4276
+ {
4277
+ code: 409,
4278
+ message: "Resource already exists",
4279
+ solution: "Use different name or update existing resource",
4280
+ },
4281
+ {
4282
+ code: 429,
4283
+ message: "Rate limit exceeded",
4284
+ solution: "Wait before retrying the operation",
4285
+ },
4286
+ {
4287
+ code: 500,
4288
+ message: "Server error",
4289
+ solution: "Retry operation or contact support",
4290
+ },
4291
+ ],
4292
+ conditions: {
4293
+ postconditions: [],
4294
+ prerequisites: ["Active namespace", "Policy parameters defined"],
4295
+ },
4296
+ confirmation_required: false,
4297
+ 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
+ field_docs: {},
4306
+ optional_fields: [],
4307
+ performance_impact: {
4308
+ latency: "moderate",
4309
+ resource_usage: "moderate",
4310
+ },
4311
+ purpose: "List all waf-exclusion-policys",
4312
+ required_fields: ["path.namespace"],
4313
+ side_effects: {},
4314
+ },
4315
+ },
4316
+ {
4317
+ toolName: "f5xc-api-waf-waf-exclusion-policy-update",
4318
+ method: "PUT",
4319
+ path: "/api/config/namespaces/{metadata.namespace}/waf_exclusion_policys/{metadata.name}",
4320
+ operation: "update",
4321
+ domain: "waf",
4322
+ resource: "waf-exclusion-policy",
4323
+ summary: "Replace WAF Exclusion Policy.",
4324
+ description: "Replace an existing WAF exclusion policy.",
4325
+ pathParameters: [
4326
+ {
4327
+ description: "Name\nThe configuration object to be replaced will be looked up by name.",
4328
+ in: "path",
4329
+ name: "metadata.name",
4330
+ required: true,
4331
+ schema: {
4332
+ type: "string",
4333
+ },
4334
+ "x-displayname": "Name",
4335
+ "x-ves-example": "Example-corp-web.",
4336
+ },
4337
+ {
4338
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
4339
+ in: "path",
4340
+ name: "metadata.namespace",
4341
+ required: true,
4342
+ schema: {
4343
+ type: "string",
4344
+ },
4345
+ "x-displayname": "Namespace",
4346
+ "x-ves-example": "Staging",
4347
+ },
4348
+ ],
4349
+ queryParameters: [],
4350
+ requestBodySchema: {
4351
+ $ref: "#/components/schemas/waf_exclusion_policyReplaceRequest",
4352
+ },
4353
+ responseSchema: {
4354
+ $ref: "#/components/schemas/waf_exclusion_policyReplaceResponse",
4355
+ },
4356
+ requiredParams: ["body", "metadata.name", "metadata.namespace"],
4357
+ operationId: "ves.io.schema.waf_exclusion_policy.API.Replace",
4358
+ tags: ["Other"],
4359
+ sourceFile: "domains/waf.json",
4360
+ displayName: null,
4361
+ dangerLevel: "medium",
4362
+ sideEffects: {
4363
+ modifies: ["waf-exclusion-policy"],
4364
+ },
4365
+ 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
+ confirmationRequired: false,
4374
+ parameterExamples: {
4375
+ "metadata.name": "Example-corp-web.",
4376
+ "metadata.namespace": "Staging",
4377
+ },
4378
+ validationRules: {},
4379
+ operationMetadata: {
4380
+ common_errors: [
4381
+ {
4382
+ code: 401,
4383
+ message: "Authentication required",
4384
+ solution: "Provide valid API credentials",
4385
+ },
4386
+ {
4387
+ code: 403,
4388
+ message: "Permission denied",
4389
+ solution: "Check access permissions for this operation",
4390
+ },
4391
+ {
4392
+ code: 404,
4393
+ message: "Resource not found",
4394
+ solution: "Verify resource name, namespace, and path",
4395
+ },
4396
+ {
4397
+ code: 409,
4398
+ message: "Resource already exists",
4399
+ solution: "Use different name or update existing resource",
4400
+ },
4401
+ {
4402
+ code: 429,
4403
+ message: "Rate limit exceeded",
4404
+ solution: "Wait before retrying the operation",
4405
+ },
4406
+ {
4407
+ code: 500,
4408
+ message: "Server error",
4409
+ solution: "Retry operation or contact support",
4410
+ },
4411
+ ],
4412
+ conditions: {
4413
+ postconditions: ["Resource updated with new values"],
4414
+ prerequisites: ["Active namespace", "Policy parameters defined"],
4415
+ },
4416
+ confirmation_required: false,
4417
+ 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
+ field_docs: {},
4426
+ optional_fields: [],
4427
+ performance_impact: {
4428
+ latency: "low",
4429
+ resource_usage: "low",
4430
+ },
4431
+ purpose: "Replace existing waf-exclusion-policy",
4432
+ required_fields: ["path.metadata.name", "path.metadata.namespace"],
4433
+ side_effects: {
4434
+ modifies: ["waf-exclusion-policy"],
4435
+ },
4436
+ },
4437
+ },
4438
+ ];
4439
+ export default wafTools;
4440
+ //# sourceMappingURL=index.js.map