@distilled.cloud/cloudflare 0.0.0 → 0.2.3

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 (560) hide show
  1. package/README.md +41 -7
  2. package/lib/auth.d.ts +13 -0
  3. package/lib/auth.d.ts.map +1 -0
  4. package/lib/auth.js +12 -0
  5. package/lib/auth.js.map +1 -0
  6. package/lib/category.d.ts +2 -0
  7. package/lib/category.d.ts.map +1 -0
  8. package/lib/category.js +2 -0
  9. package/lib/category.js.map +1 -0
  10. package/lib/client/api.d.ts +14 -0
  11. package/lib/client/api.d.ts.map +1 -0
  12. package/lib/client/api.js +245 -0
  13. package/lib/client/api.js.map +1 -0
  14. package/lib/client/index.d.ts +8 -0
  15. package/lib/client/index.d.ts.map +1 -0
  16. package/lib/client/index.js +8 -0
  17. package/lib/client/index.js.map +1 -0
  18. package/lib/credentials.d.ts +14 -0
  19. package/lib/credentials.d.ts.map +1 -0
  20. package/lib/credentials.js +17 -0
  21. package/lib/credentials.js.map +1 -0
  22. package/lib/errors.d.ts +37 -0
  23. package/lib/errors.d.ts.map +1 -0
  24. package/lib/errors.js +31 -0
  25. package/lib/errors.js.map +1 -0
  26. package/lib/index.d.ts +10 -0
  27. package/lib/index.d.ts.map +1 -0
  28. package/lib/index.js +10 -0
  29. package/lib/index.js.map +1 -0
  30. package/lib/retry.d.ts +14 -0
  31. package/lib/retry.d.ts.map +1 -0
  32. package/lib/retry.js +14 -0
  33. package/lib/retry.js.map +1 -0
  34. package/lib/schemas.d.ts +29 -0
  35. package/lib/schemas.d.ts.map +1 -0
  36. package/lib/schemas.js +34 -0
  37. package/lib/schemas.js.map +1 -0
  38. package/lib/services/abuse-reports.d.ts +224 -0
  39. package/lib/services/abuse-reports.d.ts.map +1 -0
  40. package/lib/services/abuse-reports.js +353 -0
  41. package/lib/services/abuse-reports.js.map +1 -0
  42. package/lib/services/accounts.d.ts +682 -0
  43. package/lib/services/accounts.d.ts.map +1 -0
  44. package/lib/services/accounts.js +805 -0
  45. package/lib/services/accounts.js.map +1 -0
  46. package/lib/services/acm.d.ts +73 -0
  47. package/lib/services/acm.d.ts.map +1 -0
  48. package/lib/services/acm.js +76 -0
  49. package/lib/services/acm.js.map +1 -0
  50. package/lib/services/addressing.d.ts +1208 -0
  51. package/lib/services/addressing.d.ts.map +1 -0
  52. package/lib/services/addressing.js +1776 -0
  53. package/lib/services/addressing.js.map +1 -0
  54. package/lib/services/ai-gateway.d.ts +956 -0
  55. package/lib/services/ai-gateway.d.ts.map +1 -0
  56. package/lib/services/ai-gateway.js +1706 -0
  57. package/lib/services/ai-gateway.js.map +1 -0
  58. package/lib/services/ai.d.ts +243 -0
  59. package/lib/services/ai.d.ts.map +1 -0
  60. package/lib/services/ai.js +299 -0
  61. package/lib/services/ai.js.map +1 -0
  62. package/lib/services/aisearch.d.ts +915 -0
  63. package/lib/services/aisearch.d.ts.map +1 -0
  64. package/lib/services/aisearch.js +2425 -0
  65. package/lib/services/aisearch.js.map +1 -0
  66. package/lib/services/alerting.d.ts +718 -0
  67. package/lib/services/alerting.d.ts.map +1 -0
  68. package/lib/services/alerting.js +1388 -0
  69. package/lib/services/alerting.js.map +1 -0
  70. package/lib/services/api-gateway.d.ts +830 -0
  71. package/lib/services/api-gateway.d.ts.map +1 -0
  72. package/lib/services/api-gateway.js +1548 -0
  73. package/lib/services/api-gateway.js.map +1 -0
  74. package/lib/services/argo.d.ts +101 -0
  75. package/lib/services/argo.d.ts.map +1 -0
  76. package/lib/services/argo.js +105 -0
  77. package/lib/services/argo.js.map +1 -0
  78. package/lib/services/audit-logs.d.ts +46 -0
  79. package/lib/services/audit-logs.d.ts.map +1 -0
  80. package/lib/services/audit-logs.js +37 -0
  81. package/lib/services/audit-logs.js.map +1 -0
  82. package/lib/services/billing.d.ts +62 -0
  83. package/lib/services/billing.d.ts.map +1 -0
  84. package/lib/services/billing.js +100 -0
  85. package/lib/services/billing.js.map +1 -0
  86. package/lib/services/bot-management.d.ts +124 -0
  87. package/lib/services/bot-management.d.ts.map +1 -0
  88. package/lib/services/bot-management.js +262 -0
  89. package/lib/services/bot-management.js.map +1 -0
  90. package/lib/services/botnet-feed.d.ts +65 -0
  91. package/lib/services/botnet-feed.d.ts.map +1 -0
  92. package/lib/services/botnet-feed.js +84 -0
  93. package/lib/services/botnet-feed.js.map +1 -0
  94. package/lib/services/brand-protection.d.ts +188 -0
  95. package/lib/services/brand-protection.d.ts.map +1 -0
  96. package/lib/services/brand-protection.js +214 -0
  97. package/lib/services/brand-protection.js.map +1 -0
  98. package/lib/services/browser-rendering.d.ts +857 -0
  99. package/lib/services/browser-rendering.d.ts.map +1 -0
  100. package/lib/services/browser-rendering.js +1141 -0
  101. package/lib/services/browser-rendering.js.map +1 -0
  102. package/lib/services/cache.d.ts +287 -0
  103. package/lib/services/cache.d.ts.map +1 -0
  104. package/lib/services/cache.js +330 -0
  105. package/lib/services/cache.js.map +1 -0
  106. package/lib/services/calls.d.ts +202 -0
  107. package/lib/services/calls.d.ts.map +1 -0
  108. package/lib/services/calls.js +175 -0
  109. package/lib/services/calls.js.map +1 -0
  110. package/lib/services/certificate-authorities.d.ts +40 -0
  111. package/lib/services/certificate-authorities.d.ts.map +1 -0
  112. package/lib/services/certificate-authorities.js +49 -0
  113. package/lib/services/certificate-authorities.js.map +1 -0
  114. package/lib/services/client-certificates.d.ts +254 -0
  115. package/lib/services/client-certificates.d.ts.map +1 -0
  116. package/lib/services/client-certificates.js +350 -0
  117. package/lib/services/client-certificates.js.map +1 -0
  118. package/lib/services/cloud-connector.d.ts +59 -0
  119. package/lib/services/cloud-connector.d.ts.map +1 -0
  120. package/lib/services/cloud-connector.js +84 -0
  121. package/lib/services/cloud-connector.js.map +1 -0
  122. package/lib/services/cloudforce-one.d.ts +1318 -0
  123. package/lib/services/cloudforce-one.d.ts.map +1 -0
  124. package/lib/services/cloudforce-one.js +1684 -0
  125. package/lib/services/cloudforce-one.js.map +1 -0
  126. package/lib/services/connectivity.d.ts +248 -0
  127. package/lib/services/connectivity.d.ts.map +1 -0
  128. package/lib/services/connectivity.js +377 -0
  129. package/lib/services/connectivity.js.map +1 -0
  130. package/lib/services/content-scanning.d.ts +131 -0
  131. package/lib/services/content-scanning.d.ts.map +1 -0
  132. package/lib/services/content-scanning.js +156 -0
  133. package/lib/services/content-scanning.js.map +1 -0
  134. package/lib/services/custom-certificates.d.ts +211 -0
  135. package/lib/services/custom-certificates.d.ts.map +1 -0
  136. package/lib/services/custom-certificates.js +309 -0
  137. package/lib/services/custom-certificates.js.map +1 -0
  138. package/lib/services/custom-hostnames.d.ts +525 -0
  139. package/lib/services/custom-hostnames.d.ts.map +1 -0
  140. package/lib/services/custom-hostnames.js +1164 -0
  141. package/lib/services/custom-hostnames.js.map +1 -0
  142. package/lib/services/custom-nameservers.d.ts +67 -0
  143. package/lib/services/custom-nameservers.d.ts.map +1 -0
  144. package/lib/services/custom-nameservers.js +80 -0
  145. package/lib/services/custom-nameservers.js.map +1 -0
  146. package/lib/services/custom-pages.d.ts +74 -0
  147. package/lib/services/custom-pages.d.ts.map +1 -0
  148. package/lib/services/custom-pages.js +125 -0
  149. package/lib/services/custom-pages.js.map +1 -0
  150. package/lib/services/d1.d.ts +326 -0
  151. package/lib/services/d1.d.ts.map +1 -0
  152. package/lib/services/d1.js +448 -0
  153. package/lib/services/d1.js.map +1 -0
  154. package/lib/services/dcv-delegation.d.ts +24 -0
  155. package/lib/services/dcv-delegation.d.ts.map +1 -0
  156. package/lib/services/dcv-delegation.js +24 -0
  157. package/lib/services/dcv-delegation.js.map +1 -0
  158. package/lib/services/diagnostics.d.ts +175 -0
  159. package/lib/services/diagnostics.d.ts.map +1 -0
  160. package/lib/services/diagnostics.js +273 -0
  161. package/lib/services/diagnostics.js.map +1 -0
  162. package/lib/services/dns-firewall.d.ts +288 -0
  163. package/lib/services/dns-firewall.d.ts.map +1 -0
  164. package/lib/services/dns-firewall.js +373 -0
  165. package/lib/services/dns-firewall.js.map +1 -0
  166. package/lib/services/dns.d.ts +2946 -0
  167. package/lib/services/dns.d.ts.map +1 -0
  168. package/lib/services/dns.js +4511 -0
  169. package/lib/services/dns.js.map +1 -0
  170. package/lib/services/durable-objects.d.ts +61 -0
  171. package/lib/services/durable-objects.d.ts.map +1 -0
  172. package/lib/services/durable-objects.js +66 -0
  173. package/lib/services/durable-objects.js.map +1 -0
  174. package/lib/services/email-routing.d.ts +542 -0
  175. package/lib/services/email-routing.d.ts.map +1 -0
  176. package/lib/services/email-routing.js +662 -0
  177. package/lib/services/email-routing.js.map +1 -0
  178. package/lib/services/email-security.d.ts +1131 -0
  179. package/lib/services/email-security.d.ts.map +1 -0
  180. package/lib/services/email-security.js +2065 -0
  181. package/lib/services/email-security.js.map +1 -0
  182. package/lib/services/filters.d.ts +157 -0
  183. package/lib/services/filters.d.ts.map +1 -0
  184. package/lib/services/filters.js +135 -0
  185. package/lib/services/filters.js.map +1 -0
  186. package/lib/services/firewall.d.ts +1080 -0
  187. package/lib/services/firewall.d.ts.map +1 -0
  188. package/lib/services/firewall.js +1881 -0
  189. package/lib/services/firewall.js.map +1 -0
  190. package/lib/services/healthchecks.d.ts +464 -0
  191. package/lib/services/healthchecks.d.ts.map +1 -0
  192. package/lib/services/healthchecks.js +838 -0
  193. package/lib/services/healthchecks.js.map +1 -0
  194. package/lib/services/hostnames.d.ts +74 -0
  195. package/lib/services/hostnames.d.ts.map +1 -0
  196. package/lib/services/hostnames.js +100 -0
  197. package/lib/services/hostnames.js.map +1 -0
  198. package/lib/services/hyperdrive.d.ts +203 -0
  199. package/lib/services/hyperdrive.d.ts.map +1 -0
  200. package/lib/services/hyperdrive.js +299 -0
  201. package/lib/services/hyperdrive.js.map +1 -0
  202. package/lib/services/iam.d.ts +554 -0
  203. package/lib/services/iam.d.ts.map +1 -0
  204. package/lib/services/iam.js +743 -0
  205. package/lib/services/iam.js.map +1 -0
  206. package/lib/services/images.d.ts +403 -0
  207. package/lib/services/images.d.ts.map +1 -0
  208. package/lib/services/images.js +417 -0
  209. package/lib/services/images.js.map +1 -0
  210. package/lib/services/intel.d.ts +768 -0
  211. package/lib/services/intel.d.ts.map +1 -0
  212. package/lib/services/intel.js +1179 -0
  213. package/lib/services/intel.js.map +1 -0
  214. package/lib/services/ips.d.ts +28 -0
  215. package/lib/services/ips.d.ts.map +1 -0
  216. package/lib/services/ips.js +39 -0
  217. package/lib/services/ips.js.map +1 -0
  218. package/lib/services/keyless-certificates.d.ts +177 -0
  219. package/lib/services/keyless-certificates.d.ts.map +1 -0
  220. package/lib/services/keyless-certificates.js +216 -0
  221. package/lib/services/keyless-certificates.js.map +1 -0
  222. package/lib/services/kv.d.ts +339 -0
  223. package/lib/services/kv.d.ts.map +1 -0
  224. package/lib/services/kv.js +402 -0
  225. package/lib/services/kv.js.map +1 -0
  226. package/lib/services/leaked-credential-checks.d.ts +119 -0
  227. package/lib/services/leaked-credential-checks.d.ts.map +1 -0
  228. package/lib/services/leaked-credential-checks.js +130 -0
  229. package/lib/services/leaked-credential-checks.js.map +1 -0
  230. package/lib/services/load-balancers.d.ts +1767 -0
  231. package/lib/services/load-balancers.d.ts.map +1 -0
  232. package/lib/services/load-balancers.js +3068 -0
  233. package/lib/services/load-balancers.js.map +1 -0
  234. package/lib/services/logpush.d.ts +401 -0
  235. package/lib/services/logpush.d.ts.map +1 -0
  236. package/lib/services/logpush.js +724 -0
  237. package/lib/services/logpush.js.map +1 -0
  238. package/lib/services/logs.d.ts +125 -0
  239. package/lib/services/logs.d.ts.map +1 -0
  240. package/lib/services/logs.js +145 -0
  241. package/lib/services/logs.js.map +1 -0
  242. package/lib/services/magic-cloud-networking.d.ts +1599 -0
  243. package/lib/services/magic-cloud-networking.d.ts.map +1 -0
  244. package/lib/services/magic-cloud-networking.js +5205 -0
  245. package/lib/services/magic-cloud-networking.js.map +1 -0
  246. package/lib/services/magic-network-monitoring.d.ts +379 -0
  247. package/lib/services/magic-network-monitoring.d.ts.map +1 -0
  248. package/lib/services/magic-network-monitoring.js +535 -0
  249. package/lib/services/magic-network-monitoring.js.map +1 -0
  250. package/lib/services/magic-transit.d.ts +3650 -0
  251. package/lib/services/magic-transit.d.ts.map +1 -0
  252. package/lib/services/magic-transit.js +6120 -0
  253. package/lib/services/magic-transit.js.map +1 -0
  254. package/lib/services/managed-transforms.d.ts +79 -0
  255. package/lib/services/managed-transforms.d.ts.map +1 -0
  256. package/lib/services/managed-transforms.js +107 -0
  257. package/lib/services/managed-transforms.js.map +1 -0
  258. package/lib/services/memberships.d.ts +172 -0
  259. package/lib/services/memberships.d.ts.map +1 -0
  260. package/lib/services/memberships.js +282 -0
  261. package/lib/services/memberships.js.map +1 -0
  262. package/lib/services/mtls-certificates.d.ts +140 -0
  263. package/lib/services/mtls-certificates.d.ts.map +1 -0
  264. package/lib/services/mtls-certificates.js +173 -0
  265. package/lib/services/mtls-certificates.js.map +1 -0
  266. package/lib/services/network-interconnects.d.ts +410 -0
  267. package/lib/services/network-interconnects.d.ts.map +1 -0
  268. package/lib/services/network-interconnects.js +583 -0
  269. package/lib/services/network-interconnects.js.map +1 -0
  270. package/lib/services/organizations.d.ts +201 -0
  271. package/lib/services/organizations.d.ts.map +1 -0
  272. package/lib/services/organizations.js +355 -0
  273. package/lib/services/organizations.js.map +1 -0
  274. package/lib/services/origin-ca-certificates.d.ts +99 -0
  275. package/lib/services/origin-ca-certificates.d.ts.map +1 -0
  276. package/lib/services/origin-ca-certificates.js +156 -0
  277. package/lib/services/origin-ca-certificates.js.map +1 -0
  278. package/lib/services/origin-post-quantum-encryption.d.ts +50 -0
  279. package/lib/services/origin-post-quantum-encryption.d.ts.map +1 -0
  280. package/lib/services/origin-post-quantum-encryption.js +60 -0
  281. package/lib/services/origin-post-quantum-encryption.js.map +1 -0
  282. package/lib/services/origin-tls-client-auth.d.ts +273 -0
  283. package/lib/services/origin-tls-client-auth.d.ts.map +1 -0
  284. package/lib/services/origin-tls-client-auth.js +401 -0
  285. package/lib/services/origin-tls-client-auth.js.map +1 -0
  286. package/lib/services/page-rules.d.ts +773 -0
  287. package/lib/services/page-rules.d.ts.map +1 -0
  288. package/lib/services/page-rules.js +1365 -0
  289. package/lib/services/page-rules.js.map +1 -0
  290. package/lib/services/page-shield.d.ts +426 -0
  291. package/lib/services/page-shield.d.ts.map +1 -0
  292. package/lib/services/page-shield.js +484 -0
  293. package/lib/services/page-shield.js.map +1 -0
  294. package/lib/services/pages.d.ts +1654 -0
  295. package/lib/services/pages.d.ts.map +1 -0
  296. package/lib/services/pages.js +2954 -0
  297. package/lib/services/pages.js.map +1 -0
  298. package/lib/services/pipelines.d.ts +1461 -0
  299. package/lib/services/pipelines.d.ts.map +1 -0
  300. package/lib/services/pipelines.js +2912 -0
  301. package/lib/services/pipelines.js.map +1 -0
  302. package/lib/services/queues.d.ts +807 -0
  303. package/lib/services/queues.d.ts.map +1 -0
  304. package/lib/services/queues.js +1194 -0
  305. package/lib/services/queues.js.map +1 -0
  306. package/lib/services/r2-data-catalog.d.ts +341 -0
  307. package/lib/services/r2-data-catalog.d.ts.map +1 -0
  308. package/lib/services/r2-data-catalog.js +499 -0
  309. package/lib/services/r2-data-catalog.js.map +1 -0
  310. package/lib/services/r2.d.ts +1041 -0
  311. package/lib/services/r2.d.ts.map +1 -0
  312. package/lib/services/r2.js +1384 -0
  313. package/lib/services/r2.js.map +1 -0
  314. package/lib/services/radar.d.ts +9276 -0
  315. package/lib/services/radar.d.ts.map +1 -0
  316. package/lib/services/radar.js +20491 -0
  317. package/lib/services/radar.js.map +1 -0
  318. package/lib/services/rate-limits.d.ts +315 -0
  319. package/lib/services/rate-limits.d.ts.map +1 -0
  320. package/lib/services/rate-limits.js +521 -0
  321. package/lib/services/rate-limits.js.map +1 -0
  322. package/lib/services/realtime-kit.d.ts +2728 -0
  323. package/lib/services/realtime-kit.d.ts.map +1 -0
  324. package/lib/services/realtime-kit.js +5401 -0
  325. package/lib/services/realtime-kit.js.map +1 -0
  326. package/lib/services/registrar.d.ts +81 -0
  327. package/lib/services/registrar.d.ts.map +1 -0
  328. package/lib/services/registrar.js +154 -0
  329. package/lib/services/registrar.js.map +1 -0
  330. package/lib/services/request-tracers.d.ts +61 -0
  331. package/lib/services/request-tracers.d.ts.map +1 -0
  332. package/lib/services/request-tracers.js +82 -0
  333. package/lib/services/request-tracers.js.map +1 -0
  334. package/lib/services/resource-sharing.d.ts +540 -0
  335. package/lib/services/resource-sharing.d.ts.map +1 -0
  336. package/lib/services/resource-sharing.js +846 -0
  337. package/lib/services/resource-sharing.js.map +1 -0
  338. package/lib/services/rules.d.ts +297 -0
  339. package/lib/services/rules.d.ts.map +1 -0
  340. package/lib/services/rules.js +396 -0
  341. package/lib/services/rules.js.map +1 -0
  342. package/lib/services/rulesets.d.ts +3300 -0
  343. package/lib/services/rulesets.d.ts.map +1 -0
  344. package/lib/services/rulesets.js +7852 -0
  345. package/lib/services/rulesets.js.map +1 -0
  346. package/lib/services/rum.d.ts +289 -0
  347. package/lib/services/rum.d.ts.map +1 -0
  348. package/lib/services/rum.js +409 -0
  349. package/lib/services/rum.js.map +1 -0
  350. package/lib/services/schema-validation.d.ts +240 -0
  351. package/lib/services/schema-validation.d.ts.map +1 -0
  352. package/lib/services/schema-validation.js +306 -0
  353. package/lib/services/schema-validation.js.map +1 -0
  354. package/lib/services/secrets-store.d.ts +321 -0
  355. package/lib/services/secrets-store.d.ts.map +1 -0
  356. package/lib/services/secrets-store.js +385 -0
  357. package/lib/services/secrets-store.js.map +1 -0
  358. package/lib/services/security-center.d.ts +102 -0
  359. package/lib/services/security-center.d.ts.map +1 -0
  360. package/lib/services/security-center.js +170 -0
  361. package/lib/services/security-center.js.map +1 -0
  362. package/lib/services/security-txt.d.ts +105 -0
  363. package/lib/services/security-txt.d.ts.map +1 -0
  364. package/lib/services/security-txt.js +136 -0
  365. package/lib/services/security-txt.js.map +1 -0
  366. package/lib/services/snippets.d.ts +138 -0
  367. package/lib/services/snippets.d.ts.map +1 -0
  368. package/lib/services/snippets.js +178 -0
  369. package/lib/services/snippets.js.map +1 -0
  370. package/lib/services/spectrum.d.ts +316 -0
  371. package/lib/services/spectrum.d.ts.map +1 -0
  372. package/lib/services/spectrum.js +510 -0
  373. package/lib/services/spectrum.js.map +1 -0
  374. package/lib/services/speed.d.ts +227 -0
  375. package/lib/services/speed.d.ts.map +1 -0
  376. package/lib/services/speed.js +444 -0
  377. package/lib/services/speed.js.map +1 -0
  378. package/lib/services/ssl.d.ts +370 -0
  379. package/lib/services/ssl.d.ts.map +1 -0
  380. package/lib/services/ssl.js +732 -0
  381. package/lib/services/ssl.js.map +1 -0
  382. package/lib/services/stream.d.ts +1014 -0
  383. package/lib/services/stream.d.ts.map +1 -0
  384. package/lib/services/stream.js +1049 -0
  385. package/lib/services/stream.js.map +1 -0
  386. package/lib/services/token-validation.d.ts +547 -0
  387. package/lib/services/token-validation.d.ts.map +1 -0
  388. package/lib/services/token-validation.js +768 -0
  389. package/lib/services/token-validation.js.map +1 -0
  390. package/lib/services/turnstile.d.ts +248 -0
  391. package/lib/services/turnstile.d.ts.map +1 -0
  392. package/lib/services/turnstile.js +308 -0
  393. package/lib/services/turnstile.js.map +1 -0
  394. package/lib/services/url-normalization.d.ts +53 -0
  395. package/lib/services/url-normalization.d.ts.map +1 -0
  396. package/lib/services/url-normalization.js +52 -0
  397. package/lib/services/url-normalization.js.map +1 -0
  398. package/lib/services/url-scanner.d.ts +612 -0
  399. package/lib/services/url-scanner.d.ts.map +1 -0
  400. package/lib/services/url-scanner.js +915 -0
  401. package/lib/services/url-scanner.js.map +1 -0
  402. package/lib/services/user.d.ts +441 -0
  403. package/lib/services/user.d.ts.map +1 -0
  404. package/lib/services/user.js +567 -0
  405. package/lib/services/user.js.map +1 -0
  406. package/lib/services/vectorize.d.ts +282 -0
  407. package/lib/services/vectorize.d.ts.map +1 -0
  408. package/lib/services/vectorize.js +340 -0
  409. package/lib/services/vectorize.js.map +1 -0
  410. package/lib/services/waiting-rooms.d.ts +1009 -0
  411. package/lib/services/waiting-rooms.d.ts.map +1 -0
  412. package/lib/services/waiting-rooms.js +1757 -0
  413. package/lib/services/waiting-rooms.js.map +1 -0
  414. package/lib/services/web3.d.ts +274 -0
  415. package/lib/services/web3.d.ts.map +1 -0
  416. package/lib/services/web3.js +362 -0
  417. package/lib/services/web3.js.map +1 -0
  418. package/lib/services/workers-for-platforms.d.ts +1224 -0
  419. package/lib/services/workers-for-platforms.d.ts.map +1 -0
  420. package/lib/services/workers-for-platforms.js +2078 -0
  421. package/lib/services/workers-for-platforms.js.map +1 -0
  422. package/lib/services/workers.d.ts +3498 -0
  423. package/lib/services/workers.d.ts.map +1 -0
  424. package/lib/services/workers.js +5967 -0
  425. package/lib/services/workers.js.map +1 -0
  426. package/lib/services/workflows.d.ts +359 -0
  427. package/lib/services/workflows.d.ts.map +1 -0
  428. package/lib/services/workflows.js +516 -0
  429. package/lib/services/workflows.js.map +1 -0
  430. package/lib/services/zaraz.d.ts +300 -0
  431. package/lib/services/zaraz.d.ts.map +1 -0
  432. package/lib/services/zaraz.js +298 -0
  433. package/lib/services/zaraz.js.map +1 -0
  434. package/lib/services/zero-trust.d.ts +15449 -0
  435. package/lib/services/zero-trust.d.ts.map +1 -0
  436. package/lib/services/zero-trust.js +29194 -0
  437. package/lib/services/zero-trust.js.map +1 -0
  438. package/lib/services/zones.d.ts +1278 -0
  439. package/lib/services/zones.d.ts.map +1 -0
  440. package/lib/services/zones.js +2416 -0
  441. package/lib/services/zones.js.map +1 -0
  442. package/lib/traits.d.ts +28 -0
  443. package/lib/traits.d.ts.map +1 -0
  444. package/lib/traits.js +26 -0
  445. package/lib/traits.js.map +1 -0
  446. package/package.json +68 -5
  447. package/src/auth.ts +14 -0
  448. package/src/category.ts +1 -0
  449. package/src/client/api.ts +329 -0
  450. package/src/client/index.ts +7 -0
  451. package/src/credentials.ts +30 -0
  452. package/src/errors.ts +57 -0
  453. package/src/index.ts +9 -0
  454. package/src/retry.ts +35 -0
  455. package/src/schemas.ts +51 -0
  456. package/src/services/abuse-reports.ts +747 -0
  457. package/src/services/accounts.ts +1947 -0
  458. package/src/services/acm.ts +170 -0
  459. package/src/services/addressing.ts +3947 -0
  460. package/src/services/ai-gateway.ts +3335 -0
  461. package/src/services/ai.ts +727 -0
  462. package/src/services/aisearch.ts +4750 -0
  463. package/src/services/alerting.ts +2947 -0
  464. package/src/services/api-gateway.ts +3391 -0
  465. package/src/services/argo.ts +254 -0
  466. package/src/services/audit-logs.ts +90 -0
  467. package/src/services/billing.ts +172 -0
  468. package/src/services/bot-management.ts +541 -0
  469. package/src/services/botnet-feed.ts +193 -0
  470. package/src/services/brand-protection.ts +553 -0
  471. package/src/services/browser-rendering.ts +2707 -0
  472. package/src/services/cache.ts +827 -0
  473. package/src/services/calls.ts +483 -0
  474. package/src/services/certificate-authorities.ts +110 -0
  475. package/src/services/client-certificates.ts +718 -0
  476. package/src/services/cloud-connector.ts +181 -0
  477. package/src/services/cloudforce-one.ts +3876 -0
  478. package/src/services/connectivity.ts +629 -0
  479. package/src/services/content-scanning.ts +385 -0
  480. package/src/services/custom-certificates.ts +611 -0
  481. package/src/services/custom-hostnames.ts +2453 -0
  482. package/src/services/custom-nameservers.ts +182 -0
  483. package/src/services/custom-pages.ts +264 -0
  484. package/src/services/d1.ts +1034 -0
  485. package/src/services/dcv-delegation.ts +52 -0
  486. package/src/services/diagnostics.ts +603 -0
  487. package/src/services/dns-firewall.ts +823 -0
  488. package/src/services/dns.ts +8897 -0
  489. package/src/services/durable-objects.ts +148 -0
  490. package/src/services/email-routing.ts +1602 -0
  491. package/src/services/email-security.ts +4283 -0
  492. package/src/services/filters.ts +370 -0
  493. package/src/services/firewall.ts +3896 -0
  494. package/src/services/healthchecks.ts +1750 -0
  495. package/src/services/hostnames.ts +218 -0
  496. package/src/services/hyperdrive.ts +592 -0
  497. package/src/services/iam.ts +1668 -0
  498. package/src/services/images.ts +1086 -0
  499. package/src/services/intel.ts +2768 -0
  500. package/src/services/ips.ts +88 -0
  501. package/src/services/keyless-certificates.ts +462 -0
  502. package/src/services/kv.ts +1011 -0
  503. package/src/services/leaked-credential-checks.ts +325 -0
  504. package/src/services/load-balancers.ts +6438 -0
  505. package/src/services/logpush.ts +1667 -0
  506. package/src/services/logs.ts +375 -0
  507. package/src/services/magic-cloud-networking.ts +10020 -0
  508. package/src/services/magic-network-monitoring.ts +1156 -0
  509. package/src/services/magic-transit.ts +13050 -0
  510. package/src/services/managed-transforms.ts +237 -0
  511. package/src/services/memberships.ts +615 -0
  512. package/src/services/mtls-certificates.ts +374 -0
  513. package/src/services/network-interconnects.ts +1253 -0
  514. package/src/services/organizations.ts +674 -0
  515. package/src/services/origin-ca-certificates.ts +303 -0
  516. package/src/services/origin-post-quantum-encryption.ts +128 -0
  517. package/src/services/origin-tls-client-auth.ts +878 -0
  518. package/src/services/page-rules.ts +2612 -0
  519. package/src/services/page-shield.ts +1195 -0
  520. package/src/services/pages.ts +5709 -0
  521. package/src/services/pipelines.ts +6000 -0
  522. package/src/services/queues.ts +2629 -0
  523. package/src/services/r2-data-catalog.ts +1119 -0
  524. package/src/services/r2.ts +3348 -0
  525. package/src/services/radar.ts +42152 -0
  526. package/src/services/rate-limits.ts +1150 -0
  527. package/src/services/realtime-kit.ts +11079 -0
  528. package/src/services/registrar.ts +295 -0
  529. package/src/services/request-tracers.ts +158 -0
  530. package/src/services/resource-sharing.ts +1832 -0
  531. package/src/services/rules.ts +837 -0
  532. package/src/services/rulesets.ts +15144 -0
  533. package/src/services/rum.ts +901 -0
  534. package/src/services/schema-validation.ts +733 -0
  535. package/src/services/secrets-store.ts +860 -0
  536. package/src/services/security-center.ts +397 -0
  537. package/src/services/security-txt.ts +315 -0
  538. package/src/services/snippets.ts +420 -0
  539. package/src/services/spectrum.ts +1103 -0
  540. package/src/services/speed.ts +1056 -0
  541. package/src/services/ssl.ts +1587 -0
  542. package/src/services/stream.ts +2756 -0
  543. package/src/services/token-validation.ts +1585 -0
  544. package/src/services/turnstile.ts +643 -0
  545. package/src/services/url-normalization.ts +129 -0
  546. package/src/services/url-scanner.ts +1851 -0
  547. package/src/services/user.ts +1384 -0
  548. package/src/services/vectorize.ts +816 -0
  549. package/src/services/waiting-rooms.ts +3807 -0
  550. package/src/services/web3.ts +834 -0
  551. package/src/services/workers-for-platforms.ts +3859 -0
  552. package/src/services/workers.ts +11637 -0
  553. package/src/services/workflows.ts +1124 -0
  554. package/src/services/zaraz.ts +797 -0
  555. package/src/services/zero-trust.ts +58929 -0
  556. package/src/services/zones.ts +4875 -0
  557. package/src/traits.ts +47 -0
  558. package/bun.lock +0 -26
  559. package/index.ts +0 -1
  560. package/tsconfig.json +0 -29
@@ -0,0 +1,3300 @@
1
+ /**
2
+ * Cloudflare RULESETS API
3
+ *
4
+ * Generated from Cloudflare TypeScript SDK.
5
+ * DO NOT EDIT - regenerate with: bun scripts/generate.ts --service rulesets
6
+ */
7
+ import * as Schema from "effect/Schema";
8
+ import type * as HttpClient from "effect/unstable/http/HttpClient";
9
+ import * as API from "../client/api.ts";
10
+ import type { Credentials } from "../credentials";
11
+ import { type DefaultErrors } from "../errors";
12
+ export interface GetPhasRequest {
13
+ }
14
+ export declare const GetPhasRequest: Schema.Schema<GetPhasRequest>;
15
+ export interface GetPhasResponse {
16
+ /** The unique ID of the ruleset. */
17
+ id: string;
18
+ /** The kind of the ruleset. */
19
+ kind: "zone" | "managed" | "custom" | "root";
20
+ /** The timestamp of when the ruleset was last modified. */
21
+ lastUpdated: string;
22
+ /** The human-readable name of the ruleset. */
23
+ name: string;
24
+ /** The phase of the ruleset. */
25
+ phase: "ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit";
26
+ /** The list of rules in the ruleset. */
27
+ rules: (unknown | {
28
+ lastUpdated: string;
29
+ version: string;
30
+ id?: string | null;
31
+ action?: "challenge" | null;
32
+ actionParameters?: unknown | null;
33
+ categories?: string[] | null;
34
+ description?: string | null;
35
+ enabled?: boolean | null;
36
+ exposedCredentialCheck?: {
37
+ passwordExpression: string;
38
+ usernameExpression: string;
39
+ } | null;
40
+ expression?: string | null;
41
+ logging?: unknown | null;
42
+ ratelimit?: {
43
+ characteristics: string[];
44
+ period: number;
45
+ countingExpression?: string | null;
46
+ mitigationTimeout?: number | null;
47
+ requestsPerPeriod?: number | null;
48
+ requestsToOrigin?: boolean | null;
49
+ scorePerPeriod?: number | null;
50
+ scoreResponseHeaderName?: string | null;
51
+ } | null;
52
+ ref?: string | null;
53
+ } | {
54
+ lastUpdated: string;
55
+ version: string;
56
+ id?: string | null;
57
+ action?: "js_challenge" | null;
58
+ actionParameters?: unknown | null;
59
+ categories?: string[] | null;
60
+ description?: string | null;
61
+ enabled?: boolean | null;
62
+ exposedCredentialCheck?: {
63
+ passwordExpression: string;
64
+ usernameExpression: string;
65
+ } | null;
66
+ expression?: string | null;
67
+ logging?: unknown | null;
68
+ ratelimit?: {
69
+ characteristics: string[];
70
+ period: number;
71
+ countingExpression?: string | null;
72
+ mitigationTimeout?: number | null;
73
+ requestsPerPeriod?: number | null;
74
+ requestsToOrigin?: boolean | null;
75
+ scorePerPeriod?: number | null;
76
+ scoreResponseHeaderName?: string | null;
77
+ } | null;
78
+ ref?: string | null;
79
+ })[];
80
+ /** The version of the ruleset. */
81
+ version: string;
82
+ /** An informative description of the ruleset. */
83
+ description?: string | null;
84
+ }
85
+ export declare const GetPhasResponse: Schema.Schema<GetPhasResponse>;
86
+ export type GetPhasError = DefaultErrors;
87
+ export declare const getPhas: API.OperationMethod<GetPhasRequest, GetPhasResponse, GetPhasError, Credentials | HttpClient.HttpClient>;
88
+ export interface PutPhasRequest {
89
+ /** Path param: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. */
90
+ accountId?: string;
91
+ /** Path param: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. */
92
+ zoneId?: string;
93
+ /** Body param: An informative description of the ruleset. */
94
+ description?: string;
95
+ /** Body param: The human-readable name of the ruleset. */
96
+ name?: string;
97
+ /** Body param: The list of rules in the ruleset. */
98
+ rules?: (unknown | {
99
+ id?: string;
100
+ action?: "challenge";
101
+ actionParameters?: unknown;
102
+ description?: string;
103
+ enabled?: boolean;
104
+ exposedCredentialCheck?: {
105
+ passwordExpression: string;
106
+ usernameExpression: string;
107
+ };
108
+ expression?: string;
109
+ logging?: unknown;
110
+ ratelimit?: {
111
+ characteristics: string[];
112
+ period: number;
113
+ countingExpression?: string;
114
+ mitigationTimeout?: number;
115
+ requestsPerPeriod?: number;
116
+ requestsToOrigin?: boolean;
117
+ scorePerPeriod?: number;
118
+ scoreResponseHeaderName?: string;
119
+ };
120
+ ref?: string;
121
+ } | {
122
+ id?: string;
123
+ action?: "js_challenge";
124
+ actionParameters?: unknown;
125
+ description?: string;
126
+ enabled?: boolean;
127
+ exposedCredentialCheck?: {
128
+ passwordExpression: string;
129
+ usernameExpression: string;
130
+ };
131
+ expression?: string;
132
+ logging?: unknown;
133
+ ratelimit?: {
134
+ characteristics: string[];
135
+ period: number;
136
+ countingExpression?: string;
137
+ mitigationTimeout?: number;
138
+ requestsPerPeriod?: number;
139
+ requestsToOrigin?: boolean;
140
+ scorePerPeriod?: number;
141
+ scoreResponseHeaderName?: string;
142
+ };
143
+ ref?: string;
144
+ })[];
145
+ }
146
+ export declare const PutPhasRequest: Schema.Schema<PutPhasRequest>;
147
+ export interface PutPhasResponse {
148
+ /** The unique ID of the ruleset. */
149
+ id: string;
150
+ /** The kind of the ruleset. */
151
+ kind: "zone" | "managed" | "custom" | "root";
152
+ /** The timestamp of when the ruleset was last modified. */
153
+ lastUpdated: string;
154
+ /** The human-readable name of the ruleset. */
155
+ name: string;
156
+ /** The phase of the ruleset. */
157
+ phase: "ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit";
158
+ /** The list of rules in the ruleset. */
159
+ rules: (unknown | {
160
+ lastUpdated: string;
161
+ version: string;
162
+ id?: string | null;
163
+ action?: "challenge" | null;
164
+ actionParameters?: unknown | null;
165
+ categories?: string[] | null;
166
+ description?: string | null;
167
+ enabled?: boolean | null;
168
+ exposedCredentialCheck?: {
169
+ passwordExpression: string;
170
+ usernameExpression: string;
171
+ } | null;
172
+ expression?: string | null;
173
+ logging?: unknown | null;
174
+ ratelimit?: {
175
+ characteristics: string[];
176
+ period: number;
177
+ countingExpression?: string | null;
178
+ mitigationTimeout?: number | null;
179
+ requestsPerPeriod?: number | null;
180
+ requestsToOrigin?: boolean | null;
181
+ scorePerPeriod?: number | null;
182
+ scoreResponseHeaderName?: string | null;
183
+ } | null;
184
+ ref?: string | null;
185
+ } | {
186
+ lastUpdated: string;
187
+ version: string;
188
+ id?: string | null;
189
+ action?: "js_challenge" | null;
190
+ actionParameters?: unknown | null;
191
+ categories?: string[] | null;
192
+ description?: string | null;
193
+ enabled?: boolean | null;
194
+ exposedCredentialCheck?: {
195
+ passwordExpression: string;
196
+ usernameExpression: string;
197
+ } | null;
198
+ expression?: string | null;
199
+ logging?: unknown | null;
200
+ ratelimit?: {
201
+ characteristics: string[];
202
+ period: number;
203
+ countingExpression?: string | null;
204
+ mitigationTimeout?: number | null;
205
+ requestsPerPeriod?: number | null;
206
+ requestsToOrigin?: boolean | null;
207
+ scorePerPeriod?: number | null;
208
+ scoreResponseHeaderName?: string | null;
209
+ } | null;
210
+ ref?: string | null;
211
+ })[];
212
+ /** The version of the ruleset. */
213
+ version: string;
214
+ /** An informative description of the ruleset. */
215
+ description?: string | null;
216
+ }
217
+ export declare const PutPhasResponse: Schema.Schema<PutPhasResponse>;
218
+ export type PutPhasError = DefaultErrors;
219
+ export declare const putPhas: API.OperationMethod<PutPhasRequest, PutPhasResponse, PutPhasError, Credentials | HttpClient.HttpClient>;
220
+ export interface GetPhasVersionRequest {
221
+ rulesetVersion: string;
222
+ }
223
+ export declare const GetPhasVersionRequest: Schema.Schema<GetPhasVersionRequest>;
224
+ export interface GetPhasVersionResponse {
225
+ /** The unique ID of the ruleset. */
226
+ id: string;
227
+ /** The kind of the ruleset. */
228
+ kind: "zone" | "managed" | "custom" | "root";
229
+ /** The timestamp of when the ruleset was last modified. */
230
+ lastUpdated: string;
231
+ /** The human-readable name of the ruleset. */
232
+ name: string;
233
+ /** The phase of the ruleset. */
234
+ phase: "ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit";
235
+ /** The list of rules in the ruleset. */
236
+ rules: (unknown | {
237
+ lastUpdated: string;
238
+ version: string;
239
+ id?: string | null;
240
+ action?: "challenge" | null;
241
+ actionParameters?: unknown | null;
242
+ categories?: string[] | null;
243
+ description?: string | null;
244
+ enabled?: boolean | null;
245
+ exposedCredentialCheck?: {
246
+ passwordExpression: string;
247
+ usernameExpression: string;
248
+ } | null;
249
+ expression?: string | null;
250
+ logging?: unknown | null;
251
+ ratelimit?: {
252
+ characteristics: string[];
253
+ period: number;
254
+ countingExpression?: string | null;
255
+ mitigationTimeout?: number | null;
256
+ requestsPerPeriod?: number | null;
257
+ requestsToOrigin?: boolean | null;
258
+ scorePerPeriod?: number | null;
259
+ scoreResponseHeaderName?: string | null;
260
+ } | null;
261
+ ref?: string | null;
262
+ } | {
263
+ lastUpdated: string;
264
+ version: string;
265
+ id?: string | null;
266
+ action?: "js_challenge" | null;
267
+ actionParameters?: unknown | null;
268
+ categories?: string[] | null;
269
+ description?: string | null;
270
+ enabled?: boolean | null;
271
+ exposedCredentialCheck?: {
272
+ passwordExpression: string;
273
+ usernameExpression: string;
274
+ } | null;
275
+ expression?: string | null;
276
+ logging?: unknown | null;
277
+ ratelimit?: {
278
+ characteristics: string[];
279
+ period: number;
280
+ countingExpression?: string | null;
281
+ mitigationTimeout?: number | null;
282
+ requestsPerPeriod?: number | null;
283
+ requestsToOrigin?: boolean | null;
284
+ scorePerPeriod?: number | null;
285
+ scoreResponseHeaderName?: string | null;
286
+ } | null;
287
+ ref?: string | null;
288
+ })[];
289
+ /** The version of the ruleset. */
290
+ version: string;
291
+ /** An informative description of the ruleset. */
292
+ description?: string | null;
293
+ }
294
+ export declare const GetPhasVersionResponse: Schema.Schema<GetPhasVersionResponse>;
295
+ export type GetPhasVersionError = DefaultErrors;
296
+ export declare const getPhasVersion: API.OperationMethod<GetPhasVersionRequest, GetPhasVersionResponse, GetPhasVersionError, Credentials | HttpClient.HttpClient>;
297
+ export interface ListPhasVersionsRequest {
298
+ }
299
+ export declare const ListPhasVersionsRequest: Schema.Schema<ListPhasVersionsRequest>;
300
+ export type ListPhasVersionsResponse = {
301
+ id: string;
302
+ kind: "zone" | "managed" | "custom" | "root";
303
+ lastUpdated: string;
304
+ name: string;
305
+ phase: "ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit";
306
+ version: string;
307
+ description?: string | null;
308
+ }[];
309
+ export declare const ListPhasVersionsResponse: Schema.Schema<ListPhasVersionsResponse>;
310
+ export type ListPhasVersionsError = DefaultErrors;
311
+ export declare const listPhasVersions: API.OperationMethod<ListPhasVersionsRequest, ListPhasVersionsResponse, ListPhasVersionsError, Credentials | HttpClient.HttpClient>;
312
+ export interface CreateRuleRequest {
313
+ rulesetId: string;
314
+ /** Path param: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. */
315
+ accountId?: string;
316
+ /** Path param: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. */
317
+ zoneId?: string;
318
+ /** Body param: The unique ID of the rule. */
319
+ id?: string;
320
+ /** Body param: The action to perform when the rule matches. */
321
+ action?: "block";
322
+ /** Body param: The parameters configuring the rule's action. */
323
+ actionParameters?: {
324
+ response?: {
325
+ content: string;
326
+ contentType: string;
327
+ statusCode: number;
328
+ };
329
+ };
330
+ /** Body param: An informative description of the rule. */
331
+ description?: string;
332
+ /** Body param: Whether the rule should be executed. */
333
+ enabled?: boolean;
334
+ /** Body param: Configuration for exposed credential checking. */
335
+ exposedCredentialCheck?: {
336
+ passwordExpression: string;
337
+ usernameExpression: string;
338
+ };
339
+ /** Body param: The expression defining which traffic will match the rule. */
340
+ expression?: string;
341
+ /** Body param: An object configuring the rule's logging behavior. */
342
+ logging?: {
343
+ enabled: boolean;
344
+ };
345
+ /** Body param: An object configuring where the rule will be placed. */
346
+ position?: {
347
+ before?: string;
348
+ } | {
349
+ after?: string;
350
+ } | {
351
+ index?: number;
352
+ };
353
+ /** Body param: An object configuring the rule's rate limit behavior. */
354
+ ratelimit?: {
355
+ characteristics: string[];
356
+ period: number;
357
+ countingExpression?: string;
358
+ mitigationTimeout?: number;
359
+ requestsPerPeriod?: number;
360
+ requestsToOrigin?: boolean;
361
+ scorePerPeriod?: number;
362
+ scoreResponseHeaderName?: string;
363
+ };
364
+ /** Body param: The reference of the rule (the rule's ID by default). */
365
+ ref?: string;
366
+ }
367
+ export declare const CreateRuleRequest: Schema.Schema<CreateRuleRequest>;
368
+ export interface CreateRuleResponse {
369
+ /** The unique ID of the ruleset. */
370
+ id: string;
371
+ /** The kind of the ruleset. */
372
+ kind: "zone" | "managed" | "custom" | "root";
373
+ /** The timestamp of when the ruleset was last modified. */
374
+ lastUpdated: string;
375
+ /** The human-readable name of the ruleset. */
376
+ name: string;
377
+ /** The phase of the ruleset. */
378
+ phase: "ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit";
379
+ /** The list of rules in the ruleset. */
380
+ rules: ({
381
+ accountId?: string | null;
382
+ zoneId?: string | null;
383
+ id?: string | null;
384
+ action?: "block" | null;
385
+ actionParameters?: {
386
+ response?: {
387
+ content: string;
388
+ contentType: string;
389
+ statusCode: number;
390
+ } | null;
391
+ } | null;
392
+ description?: string | null;
393
+ enabled?: boolean | null;
394
+ exposedCredentialCheck?: {
395
+ passwordExpression: string;
396
+ usernameExpression: string;
397
+ } | null;
398
+ expression?: string | null;
399
+ logging?: {
400
+ enabled: boolean;
401
+ } | null;
402
+ position?: {
403
+ before?: string | null;
404
+ } | {
405
+ after?: string | null;
406
+ } | {
407
+ index?: number | null;
408
+ } | null;
409
+ ratelimit?: {
410
+ characteristics: string[];
411
+ period: number;
412
+ countingExpression?: string | null;
413
+ mitigationTimeout?: number | null;
414
+ requestsPerPeriod?: number | null;
415
+ requestsToOrigin?: boolean | null;
416
+ scorePerPeriod?: number | null;
417
+ scoreResponseHeaderName?: string | null;
418
+ } | null;
419
+ ref?: string | null;
420
+ } | {
421
+ lastUpdated: string;
422
+ version: string;
423
+ id?: string | null;
424
+ action?: "challenge" | null;
425
+ actionParameters?: unknown | null;
426
+ categories?: string[] | null;
427
+ description?: string | null;
428
+ enabled?: boolean | null;
429
+ exposedCredentialCheck?: {
430
+ passwordExpression: string;
431
+ usernameExpression: string;
432
+ } | null;
433
+ expression?: string | null;
434
+ logging?: unknown | null;
435
+ ratelimit?: {
436
+ characteristics: string[];
437
+ period: number;
438
+ countingExpression?: string | null;
439
+ mitigationTimeout?: number | null;
440
+ requestsPerPeriod?: number | null;
441
+ requestsToOrigin?: boolean | null;
442
+ scorePerPeriod?: number | null;
443
+ scoreResponseHeaderName?: string | null;
444
+ } | null;
445
+ ref?: string | null;
446
+ } | {
447
+ lastUpdated: string;
448
+ version: string;
449
+ id?: string | null;
450
+ action?: "compress_response" | null;
451
+ actionParameters?: {
452
+ algorithms: {
453
+ name?: "none" | "auto" | "default" | "gzip" | "brotli" | "zstd" | null;
454
+ }[];
455
+ } | null;
456
+ categories?: string[] | null;
457
+ description?: string | null;
458
+ enabled?: boolean | null;
459
+ exposedCredentialCheck?: {
460
+ passwordExpression: string;
461
+ usernameExpression: string;
462
+ } | null;
463
+ expression?: string | null;
464
+ logging?: {
465
+ enabled: boolean;
466
+ } | null;
467
+ ratelimit?: {
468
+ characteristics: string[];
469
+ period: number;
470
+ countingExpression?: string | null;
471
+ mitigationTimeout?: number | null;
472
+ requestsPerPeriod?: number | null;
473
+ requestsToOrigin?: boolean | null;
474
+ scorePerPeriod?: number | null;
475
+ scoreResponseHeaderName?: string | null;
476
+ } | null;
477
+ ref?: string | null;
478
+ } | {
479
+ accountId?: string | null;
480
+ zoneId?: string | null;
481
+ id?: string | null;
482
+ action?: "ddos_dynamic" | null;
483
+ actionParameters?: unknown | null;
484
+ description?: string | null;
485
+ enabled?: boolean | null;
486
+ exposedCredentialCheck?: {
487
+ passwordExpression: string;
488
+ usernameExpression: string;
489
+ } | null;
490
+ expression?: string | null;
491
+ logging?: {
492
+ enabled: boolean;
493
+ } | null;
494
+ position?: {
495
+ before?: string | null;
496
+ } | {
497
+ after?: string | null;
498
+ } | {
499
+ index?: number | null;
500
+ } | null;
501
+ ratelimit?: {
502
+ characteristics: string[];
503
+ period: number;
504
+ countingExpression?: string | null;
505
+ mitigationTimeout?: number | null;
506
+ requestsPerPeriod?: number | null;
507
+ requestsToOrigin?: boolean | null;
508
+ scorePerPeriod?: number | null;
509
+ scoreResponseHeaderName?: string | null;
510
+ } | null;
511
+ ref?: string | null;
512
+ } | {
513
+ accountId?: string | null;
514
+ zoneId?: string | null;
515
+ id?: string | null;
516
+ action?: "execute" | null;
517
+ actionParameters?: {
518
+ id: string;
519
+ matchedData?: {
520
+ publicKey: string;
521
+ } | null;
522
+ overrides?: {
523
+ action?: string | null;
524
+ categories?: {
525
+ category: string;
526
+ action?: string | null;
527
+ enabled?: boolean | null;
528
+ sensitivityLevel?: "default" | "medium" | "low" | "eoff" | null;
529
+ }[] | null;
530
+ enabled?: boolean | null;
531
+ rules?: {
532
+ id: string;
533
+ action?: string | null;
534
+ enabled?: boolean | null;
535
+ scoreThreshold?: number | null;
536
+ sensitivityLevel?: "default" | "medium" | "low" | "eoff" | null;
537
+ }[] | null;
538
+ sensitivityLevel?: "default" | "medium" | "low" | "eoff" | null;
539
+ } | null;
540
+ } | null;
541
+ description?: string | null;
542
+ enabled?: boolean | null;
543
+ exposedCredentialCheck?: {
544
+ passwordExpression: string;
545
+ usernameExpression: string;
546
+ } | null;
547
+ expression?: string | null;
548
+ logging?: {
549
+ enabled: boolean;
550
+ } | null;
551
+ position?: {
552
+ before?: string | null;
553
+ } | {
554
+ after?: string | null;
555
+ } | {
556
+ index?: number | null;
557
+ } | null;
558
+ ratelimit?: {
559
+ characteristics: string[];
560
+ period: number;
561
+ countingExpression?: string | null;
562
+ mitigationTimeout?: number | null;
563
+ requestsPerPeriod?: number | null;
564
+ requestsToOrigin?: boolean | null;
565
+ scorePerPeriod?: number | null;
566
+ scoreResponseHeaderName?: string | null;
567
+ } | null;
568
+ ref?: string | null;
569
+ } | {
570
+ accountId?: string | null;
571
+ zoneId?: string | null;
572
+ id?: string | null;
573
+ action?: "force_connection_close" | null;
574
+ actionParameters?: unknown | null;
575
+ description?: string | null;
576
+ enabled?: boolean | null;
577
+ exposedCredentialCheck?: {
578
+ passwordExpression: string;
579
+ usernameExpression: string;
580
+ } | null;
581
+ expression?: string | null;
582
+ logging?: {
583
+ enabled: boolean;
584
+ } | null;
585
+ position?: {
586
+ before?: string | null;
587
+ } | {
588
+ after?: string | null;
589
+ } | {
590
+ index?: number | null;
591
+ } | null;
592
+ ratelimit?: {
593
+ characteristics: string[];
594
+ period: number;
595
+ countingExpression?: string | null;
596
+ mitigationTimeout?: number | null;
597
+ requestsPerPeriod?: number | null;
598
+ requestsToOrigin?: boolean | null;
599
+ scorePerPeriod?: number | null;
600
+ scoreResponseHeaderName?: string | null;
601
+ } | null;
602
+ ref?: string | null;
603
+ } | {
604
+ lastUpdated: string;
605
+ version: string;
606
+ id?: string | null;
607
+ action?: "js_challenge" | null;
608
+ actionParameters?: unknown | null;
609
+ categories?: string[] | null;
610
+ description?: string | null;
611
+ enabled?: boolean | null;
612
+ exposedCredentialCheck?: {
613
+ passwordExpression: string;
614
+ usernameExpression: string;
615
+ } | null;
616
+ expression?: string | null;
617
+ logging?: unknown | null;
618
+ ratelimit?: {
619
+ characteristics: string[];
620
+ period: number;
621
+ countingExpression?: string | null;
622
+ mitigationTimeout?: number | null;
623
+ requestsPerPeriod?: number | null;
624
+ requestsToOrigin?: boolean | null;
625
+ scorePerPeriod?: number | null;
626
+ scoreResponseHeaderName?: string | null;
627
+ } | null;
628
+ ref?: string | null;
629
+ } | {
630
+ accountId?: string | null;
631
+ zoneId?: string | null;
632
+ id?: string | null;
633
+ action?: "log" | null;
634
+ actionParameters?: unknown | null;
635
+ description?: string | null;
636
+ enabled?: boolean | null;
637
+ exposedCredentialCheck?: {
638
+ passwordExpression: string;
639
+ usernameExpression: string;
640
+ } | null;
641
+ expression?: string | null;
642
+ logging?: {
643
+ enabled: boolean;
644
+ } | null;
645
+ position?: {
646
+ before?: string | null;
647
+ } | {
648
+ after?: string | null;
649
+ } | {
650
+ index?: number | null;
651
+ } | null;
652
+ ratelimit?: {
653
+ characteristics: string[];
654
+ period: number;
655
+ countingExpression?: string | null;
656
+ mitigationTimeout?: number | null;
657
+ requestsPerPeriod?: number | null;
658
+ requestsToOrigin?: boolean | null;
659
+ scorePerPeriod?: number | null;
660
+ scoreResponseHeaderName?: string | null;
661
+ } | null;
662
+ ref?: string | null;
663
+ } | {
664
+ accountId?: string | null;
665
+ zoneId?: string | null;
666
+ id?: string | null;
667
+ action?: "log_custom_field" | null;
668
+ actionParameters?: {
669
+ cookieFields?: {
670
+ name: string;
671
+ }[] | null;
672
+ rawResponseFields?: {
673
+ name: string;
674
+ preserveDuplicates?: boolean | null;
675
+ }[] | null;
676
+ requestFields?: {
677
+ name: string;
678
+ }[] | null;
679
+ responseFields?: {
680
+ name: string;
681
+ preserveDuplicates?: boolean | null;
682
+ }[] | null;
683
+ transformedRequestFields?: {
684
+ name: string;
685
+ }[] | null;
686
+ } | null;
687
+ description?: string | null;
688
+ enabled?: boolean | null;
689
+ exposedCredentialCheck?: {
690
+ passwordExpression: string;
691
+ usernameExpression: string;
692
+ } | null;
693
+ expression?: string | null;
694
+ logging?: {
695
+ enabled: boolean;
696
+ } | null;
697
+ position?: {
698
+ before?: string | null;
699
+ } | {
700
+ after?: string | null;
701
+ } | {
702
+ index?: number | null;
703
+ } | null;
704
+ ratelimit?: {
705
+ characteristics: string[];
706
+ period: number;
707
+ countingExpression?: string | null;
708
+ mitigationTimeout?: number | null;
709
+ requestsPerPeriod?: number | null;
710
+ requestsToOrigin?: boolean | null;
711
+ scorePerPeriod?: number | null;
712
+ scoreResponseHeaderName?: string | null;
713
+ } | null;
714
+ ref?: string | null;
715
+ } | {
716
+ accountId?: string | null;
717
+ zoneId?: string | null;
718
+ id?: string | null;
719
+ action?: "managed_challenge" | null;
720
+ actionParameters?: unknown | null;
721
+ description?: string | null;
722
+ enabled?: boolean | null;
723
+ exposedCredentialCheck?: {
724
+ passwordExpression: string;
725
+ usernameExpression: string;
726
+ } | null;
727
+ expression?: string | null;
728
+ logging?: {
729
+ enabled: boolean;
730
+ } | null;
731
+ position?: {
732
+ before?: string | null;
733
+ } | {
734
+ after?: string | null;
735
+ } | {
736
+ index?: number | null;
737
+ } | null;
738
+ ratelimit?: {
739
+ characteristics: string[];
740
+ period: number;
741
+ countingExpression?: string | null;
742
+ mitigationTimeout?: number | null;
743
+ requestsPerPeriod?: number | null;
744
+ requestsToOrigin?: boolean | null;
745
+ scorePerPeriod?: number | null;
746
+ scoreResponseHeaderName?: string | null;
747
+ } | null;
748
+ ref?: string | null;
749
+ } | {
750
+ accountId?: string | null;
751
+ zoneId?: string | null;
752
+ id?: string | null;
753
+ action?: "redirect" | null;
754
+ actionParameters?: {
755
+ fromList?: {
756
+ key: string;
757
+ name: string;
758
+ } | null;
759
+ fromValue?: {
760
+ targetUrl: {
761
+ expression?: string | null;
762
+ value?: string | null;
763
+ };
764
+ preserveQueryString?: boolean | null;
765
+ statusCode?: "301" | "302" | "303" | "307" | "308" | null;
766
+ } | null;
767
+ } | null;
768
+ description?: string | null;
769
+ enabled?: boolean | null;
770
+ exposedCredentialCheck?: {
771
+ passwordExpression: string;
772
+ usernameExpression: string;
773
+ } | null;
774
+ expression?: string | null;
775
+ logging?: {
776
+ enabled: boolean;
777
+ } | null;
778
+ position?: {
779
+ before?: string | null;
780
+ } | {
781
+ after?: string | null;
782
+ } | {
783
+ index?: number | null;
784
+ } | null;
785
+ ratelimit?: {
786
+ characteristics: string[];
787
+ period: number;
788
+ countingExpression?: string | null;
789
+ mitigationTimeout?: number | null;
790
+ requestsPerPeriod?: number | null;
791
+ requestsToOrigin?: boolean | null;
792
+ scorePerPeriod?: number | null;
793
+ scoreResponseHeaderName?: string | null;
794
+ } | null;
795
+ ref?: string | null;
796
+ } | {
797
+ accountId?: string | null;
798
+ zoneId?: string | null;
799
+ id?: string | null;
800
+ action?: "rewrite" | null;
801
+ actionParameters?: {
802
+ headers?: Record<string, unknown> | null;
803
+ uri?: {
804
+ path: {
805
+ expression?: string | null;
806
+ value?: string | null;
807
+ };
808
+ } | {
809
+ query: {
810
+ expression?: string | null;
811
+ value?: string | null;
812
+ };
813
+ } | null;
814
+ } | null;
815
+ description?: string | null;
816
+ enabled?: boolean | null;
817
+ exposedCredentialCheck?: {
818
+ passwordExpression: string;
819
+ usernameExpression: string;
820
+ } | null;
821
+ expression?: string | null;
822
+ logging?: {
823
+ enabled: boolean;
824
+ } | null;
825
+ position?: {
826
+ before?: string | null;
827
+ } | {
828
+ after?: string | null;
829
+ } | {
830
+ index?: number | null;
831
+ } | null;
832
+ ratelimit?: {
833
+ characteristics: string[];
834
+ period: number;
835
+ countingExpression?: string | null;
836
+ mitigationTimeout?: number | null;
837
+ requestsPerPeriod?: number | null;
838
+ requestsToOrigin?: boolean | null;
839
+ scorePerPeriod?: number | null;
840
+ scoreResponseHeaderName?: string | null;
841
+ } | null;
842
+ ref?: string | null;
843
+ } | {
844
+ accountId?: string | null;
845
+ zoneId?: string | null;
846
+ id?: string | null;
847
+ action?: "route" | null;
848
+ actionParameters?: {
849
+ hostHeader?: string | null;
850
+ origin?: {
851
+ host?: string | null;
852
+ port?: number | null;
853
+ } | null;
854
+ sni?: {
855
+ value: string;
856
+ } | null;
857
+ } | null;
858
+ description?: string | null;
859
+ enabled?: boolean | null;
860
+ exposedCredentialCheck?: {
861
+ passwordExpression: string;
862
+ usernameExpression: string;
863
+ } | null;
864
+ expression?: string | null;
865
+ logging?: {
866
+ enabled: boolean;
867
+ } | null;
868
+ position?: {
869
+ before?: string | null;
870
+ } | {
871
+ after?: string | null;
872
+ } | {
873
+ index?: number | null;
874
+ } | null;
875
+ ratelimit?: {
876
+ characteristics: string[];
877
+ period: number;
878
+ countingExpression?: string | null;
879
+ mitigationTimeout?: number | null;
880
+ requestsPerPeriod?: number | null;
881
+ requestsToOrigin?: boolean | null;
882
+ scorePerPeriod?: number | null;
883
+ scoreResponseHeaderName?: string | null;
884
+ } | null;
885
+ ref?: string | null;
886
+ } | {
887
+ accountId?: string | null;
888
+ zoneId?: string | null;
889
+ id?: string | null;
890
+ action?: "score" | null;
891
+ actionParameters?: {
892
+ increment: number;
893
+ } | null;
894
+ description?: string | null;
895
+ enabled?: boolean | null;
896
+ exposedCredentialCheck?: {
897
+ passwordExpression: string;
898
+ usernameExpression: string;
899
+ } | null;
900
+ expression?: string | null;
901
+ logging?: {
902
+ enabled: boolean;
903
+ } | null;
904
+ position?: {
905
+ before?: string | null;
906
+ } | {
907
+ after?: string | null;
908
+ } | {
909
+ index?: number | null;
910
+ } | null;
911
+ ratelimit?: {
912
+ characteristics: string[];
913
+ period: number;
914
+ countingExpression?: string | null;
915
+ mitigationTimeout?: number | null;
916
+ requestsPerPeriod?: number | null;
917
+ requestsToOrigin?: boolean | null;
918
+ scorePerPeriod?: number | null;
919
+ scoreResponseHeaderName?: string | null;
920
+ } | null;
921
+ ref?: string | null;
922
+ } | {
923
+ accountId?: string | null;
924
+ zoneId?: string | null;
925
+ id?: string | null;
926
+ action?: "serve_error" | null;
927
+ actionParameters?: {
928
+ content: string;
929
+ contentType?: "application/json" | "text/html" | "text/plain" | "text/xml" | null;
930
+ statusCode?: number | null;
931
+ } | {
932
+ assetName: string;
933
+ contentType?: "application/json" | "text/html" | "text/plain" | "text/xml" | null;
934
+ statusCode?: number | null;
935
+ } | null;
936
+ description?: string | null;
937
+ enabled?: boolean | null;
938
+ exposedCredentialCheck?: {
939
+ passwordExpression: string;
940
+ usernameExpression: string;
941
+ } | null;
942
+ expression?: string | null;
943
+ logging?: {
944
+ enabled: boolean;
945
+ } | null;
946
+ position?: {
947
+ before?: string | null;
948
+ } | {
949
+ after?: string | null;
950
+ } | {
951
+ index?: number | null;
952
+ } | null;
953
+ ratelimit?: {
954
+ characteristics: string[];
955
+ period: number;
956
+ countingExpression?: string | null;
957
+ mitigationTimeout?: number | null;
958
+ requestsPerPeriod?: number | null;
959
+ requestsToOrigin?: boolean | null;
960
+ scorePerPeriod?: number | null;
961
+ scoreResponseHeaderName?: string | null;
962
+ } | null;
963
+ ref?: string | null;
964
+ } | {
965
+ accountId?: string | null;
966
+ zoneId?: string | null;
967
+ id?: string | null;
968
+ action?: "set_cache_settings" | null;
969
+ actionParameters?: {
970
+ additionalCacheablePorts?: number[] | null;
971
+ browserTtl?: {
972
+ mode: "respect_origin" | "bypass_by_default" | "override_origin" | "bypass";
973
+ default?: number | null;
974
+ } | null;
975
+ cache?: boolean | null;
976
+ cacheKey?: {
977
+ cacheByDeviceType?: boolean | null;
978
+ cacheDeceptionArmor?: boolean | null;
979
+ customKey?: {
980
+ cookie?: {
981
+ checkPresence?: string[] | null;
982
+ include?: string[] | null;
983
+ } | null;
984
+ header?: {
985
+ checkPresence?: string[] | null;
986
+ contains?: Record<string, unknown> | null;
987
+ excludeOrigin?: boolean | null;
988
+ include?: string[] | null;
989
+ } | null;
990
+ host?: {
991
+ resolved?: boolean | null;
992
+ } | null;
993
+ queryString?: {
994
+ exclude?: {
995
+ all?: true | null;
996
+ list?: string[] | null;
997
+ } | null;
998
+ include?: {
999
+ all?: true | null;
1000
+ list?: string[] | null;
1001
+ } | null;
1002
+ } | null;
1003
+ user?: {
1004
+ deviceType?: boolean | null;
1005
+ geo?: boolean | null;
1006
+ lang?: boolean | null;
1007
+ } | null;
1008
+ } | null;
1009
+ ignoreQueryStringsOrder?: boolean | null;
1010
+ } | null;
1011
+ cacheReserve?: {
1012
+ eligible: boolean;
1013
+ minimumFileSize?: number | null;
1014
+ } | null;
1015
+ edgeTtl?: {
1016
+ mode: "respect_origin" | "bypass_by_default" | "override_origin";
1017
+ default?: number | null;
1018
+ statusCodeTtl?: {
1019
+ value: number;
1020
+ statusCode?: number | null;
1021
+ statusCodeRange?: {
1022
+ from?: number | null;
1023
+ to?: number | null;
1024
+ } | null;
1025
+ }[] | null;
1026
+ } | null;
1027
+ originCacheControl?: boolean | null;
1028
+ originErrorPagePassthru?: boolean | null;
1029
+ readTimeout?: number | null;
1030
+ respectStrongEtags?: boolean | null;
1031
+ serveStale?: {
1032
+ disableStaleWhileUpdating?: boolean | null;
1033
+ } | null;
1034
+ } | null;
1035
+ description?: string | null;
1036
+ enabled?: boolean | null;
1037
+ exposedCredentialCheck?: {
1038
+ passwordExpression: string;
1039
+ usernameExpression: string;
1040
+ } | null;
1041
+ expression?: string | null;
1042
+ logging?: {
1043
+ enabled: boolean;
1044
+ } | null;
1045
+ position?: {
1046
+ before?: string | null;
1047
+ } | {
1048
+ after?: string | null;
1049
+ } | {
1050
+ index?: number | null;
1051
+ } | null;
1052
+ ratelimit?: {
1053
+ characteristics: string[];
1054
+ period: number;
1055
+ countingExpression?: string | null;
1056
+ mitigationTimeout?: number | null;
1057
+ requestsPerPeriod?: number | null;
1058
+ requestsToOrigin?: boolean | null;
1059
+ scorePerPeriod?: number | null;
1060
+ scoreResponseHeaderName?: string | null;
1061
+ } | null;
1062
+ ref?: string | null;
1063
+ } | {
1064
+ lastUpdated: string;
1065
+ version: string;
1066
+ id?: string | null;
1067
+ action?: "set_config" | null;
1068
+ actionParameters?: {
1069
+ automaticHttpsRewrites?: boolean | null;
1070
+ autominify?: {
1071
+ css?: boolean | null;
1072
+ html?: boolean | null;
1073
+ js?: boolean | null;
1074
+ } | null;
1075
+ bic?: boolean | null;
1076
+ disableApps?: true | null;
1077
+ disablePayPerCrawl?: true | null;
1078
+ disableRum?: true | null;
1079
+ disableZaraz?: true | null;
1080
+ emailObfuscation?: boolean | null;
1081
+ fonts?: boolean | null;
1082
+ hotlinkProtection?: boolean | null;
1083
+ mirage?: boolean | null;
1084
+ opportunisticEncryption?: boolean | null;
1085
+ polish?: "off" | "lossless" | "lossy" | "webp" | null;
1086
+ requestBodyBuffering?: "none" | "standard" | "full" | null;
1087
+ responseBodyBuffering?: "none" | "standard" | null;
1088
+ rocketLoader?: boolean | null;
1089
+ securityLevel?: "off" | "essentially_off" | "low" | "medium" | "high" | "under_attack" | null;
1090
+ serverSideExcludes?: boolean | null;
1091
+ ssl?: "off" | "flexible" | "full" | "strict" | "origin_pull" | null;
1092
+ sxg?: boolean | null;
1093
+ } | null;
1094
+ categories?: string[] | null;
1095
+ description?: string | null;
1096
+ enabled?: boolean | null;
1097
+ exposedCredentialCheck?: {
1098
+ passwordExpression: string;
1099
+ usernameExpression: string;
1100
+ } | null;
1101
+ expression?: string | null;
1102
+ logging?: {
1103
+ enabled: boolean;
1104
+ } | null;
1105
+ ratelimit?: {
1106
+ characteristics: string[];
1107
+ period: number;
1108
+ countingExpression?: string | null;
1109
+ mitigationTimeout?: number | null;
1110
+ requestsPerPeriod?: number | null;
1111
+ requestsToOrigin?: boolean | null;
1112
+ scorePerPeriod?: number | null;
1113
+ scoreResponseHeaderName?: string | null;
1114
+ } | null;
1115
+ ref?: string | null;
1116
+ } | {
1117
+ accountId?: string | null;
1118
+ zoneId?: string | null;
1119
+ id?: string | null;
1120
+ action?: "skip" | null;
1121
+ actionParameters?: {
1122
+ phase?: "current" | null;
1123
+ phases?: ("ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit")[] | null;
1124
+ products?: ("bic" | "hot" | "rateLimit" | "securityLevel" | "uaBlock" | "waf" | "zoneLockdown")[] | null;
1125
+ rules?: Record<string, unknown> | null;
1126
+ ruleset?: "current" | null;
1127
+ rulesets?: string[] | null;
1128
+ } | null;
1129
+ description?: string | null;
1130
+ enabled?: boolean | null;
1131
+ exposedCredentialCheck?: {
1132
+ passwordExpression: string;
1133
+ usernameExpression: string;
1134
+ } | null;
1135
+ expression?: string | null;
1136
+ logging?: {
1137
+ enabled: boolean;
1138
+ } | null;
1139
+ position?: {
1140
+ before?: string | null;
1141
+ } | {
1142
+ after?: string | null;
1143
+ } | {
1144
+ index?: number | null;
1145
+ } | null;
1146
+ ratelimit?: {
1147
+ characteristics: string[];
1148
+ period: number;
1149
+ countingExpression?: string | null;
1150
+ mitigationTimeout?: number | null;
1151
+ requestsPerPeriod?: number | null;
1152
+ requestsToOrigin?: boolean | null;
1153
+ scorePerPeriod?: number | null;
1154
+ scoreResponseHeaderName?: string | null;
1155
+ } | null;
1156
+ ref?: string | null;
1157
+ })[];
1158
+ /** The version of the ruleset. */
1159
+ version: string;
1160
+ /** An informative description of the ruleset. */
1161
+ description?: string | null;
1162
+ }
1163
+ export declare const CreateRuleResponse: Schema.Schema<CreateRuleResponse>;
1164
+ export type CreateRuleError = DefaultErrors;
1165
+ export declare const createRule: API.OperationMethod<CreateRuleRequest, CreateRuleResponse, CreateRuleError, Credentials | HttpClient.HttpClient>;
1166
+ export interface PatchRuleRequest {
1167
+ rulesetId: string;
1168
+ ruleId: string;
1169
+ /** Path param: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. */
1170
+ accountId?: string;
1171
+ /** Path param: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. */
1172
+ zoneId?: string;
1173
+ /** Body param: The unique ID of the rule. */
1174
+ id?: string;
1175
+ /** Body param: The action to perform when the rule matches. */
1176
+ action?: "block";
1177
+ /** Body param: The parameters configuring the rule's action. */
1178
+ actionParameters?: {
1179
+ response?: {
1180
+ content: string;
1181
+ contentType: string;
1182
+ statusCode: number;
1183
+ };
1184
+ };
1185
+ /** Body param: An informative description of the rule. */
1186
+ description?: string;
1187
+ /** Body param: Whether the rule should be executed. */
1188
+ enabled?: boolean;
1189
+ /** Body param: Configuration for exposed credential checking. */
1190
+ exposedCredentialCheck?: {
1191
+ passwordExpression: string;
1192
+ usernameExpression: string;
1193
+ };
1194
+ /** Body param: The expression defining which traffic will match the rule. */
1195
+ expression?: string;
1196
+ /** Body param: An object configuring the rule's logging behavior. */
1197
+ logging?: {
1198
+ enabled: boolean;
1199
+ };
1200
+ /** Body param: An object configuring where the rule will be placed. */
1201
+ position?: {
1202
+ before?: string;
1203
+ } | {
1204
+ after?: string;
1205
+ } | {
1206
+ index?: number;
1207
+ };
1208
+ /** Body param: An object configuring the rule's rate limit behavior. */
1209
+ ratelimit?: {
1210
+ characteristics: string[];
1211
+ period: number;
1212
+ countingExpression?: string;
1213
+ mitigationTimeout?: number;
1214
+ requestsPerPeriod?: number;
1215
+ requestsToOrigin?: boolean;
1216
+ scorePerPeriod?: number;
1217
+ scoreResponseHeaderName?: string;
1218
+ };
1219
+ /** Body param: The reference of the rule (the rule's ID by default). */
1220
+ ref?: string;
1221
+ }
1222
+ export declare const PatchRuleRequest: Schema.Schema<PatchRuleRequest>;
1223
+ export interface PatchRuleResponse {
1224
+ /** The unique ID of the ruleset. */
1225
+ id: string;
1226
+ /** The kind of the ruleset. */
1227
+ kind: "zone" | "managed" | "custom" | "root";
1228
+ /** The timestamp of when the ruleset was last modified. */
1229
+ lastUpdated: string;
1230
+ /** The human-readable name of the ruleset. */
1231
+ name: string;
1232
+ /** The phase of the ruleset. */
1233
+ phase: "ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit";
1234
+ /** The list of rules in the ruleset. */
1235
+ rules: ({
1236
+ accountId?: string | null;
1237
+ zoneId?: string | null;
1238
+ id?: string | null;
1239
+ action?: "block" | null;
1240
+ actionParameters?: {
1241
+ response?: {
1242
+ content: string;
1243
+ contentType: string;
1244
+ statusCode: number;
1245
+ } | null;
1246
+ } | null;
1247
+ description?: string | null;
1248
+ enabled?: boolean | null;
1249
+ exposedCredentialCheck?: {
1250
+ passwordExpression: string;
1251
+ usernameExpression: string;
1252
+ } | null;
1253
+ expression?: string | null;
1254
+ logging?: {
1255
+ enabled: boolean;
1256
+ } | null;
1257
+ position?: {
1258
+ before?: string | null;
1259
+ } | {
1260
+ after?: string | null;
1261
+ } | {
1262
+ index?: number | null;
1263
+ } | null;
1264
+ ratelimit?: {
1265
+ characteristics: string[];
1266
+ period: number;
1267
+ countingExpression?: string | null;
1268
+ mitigationTimeout?: number | null;
1269
+ requestsPerPeriod?: number | null;
1270
+ requestsToOrigin?: boolean | null;
1271
+ scorePerPeriod?: number | null;
1272
+ scoreResponseHeaderName?: string | null;
1273
+ } | null;
1274
+ ref?: string | null;
1275
+ } | {
1276
+ lastUpdated: string;
1277
+ version: string;
1278
+ id?: string | null;
1279
+ action?: "challenge" | null;
1280
+ actionParameters?: unknown | null;
1281
+ categories?: string[] | null;
1282
+ description?: string | null;
1283
+ enabled?: boolean | null;
1284
+ exposedCredentialCheck?: {
1285
+ passwordExpression: string;
1286
+ usernameExpression: string;
1287
+ } | null;
1288
+ expression?: string | null;
1289
+ logging?: unknown | null;
1290
+ ratelimit?: {
1291
+ characteristics: string[];
1292
+ period: number;
1293
+ countingExpression?: string | null;
1294
+ mitigationTimeout?: number | null;
1295
+ requestsPerPeriod?: number | null;
1296
+ requestsToOrigin?: boolean | null;
1297
+ scorePerPeriod?: number | null;
1298
+ scoreResponseHeaderName?: string | null;
1299
+ } | null;
1300
+ ref?: string | null;
1301
+ } | {
1302
+ lastUpdated: string;
1303
+ version: string;
1304
+ id?: string | null;
1305
+ action?: "compress_response" | null;
1306
+ actionParameters?: {
1307
+ algorithms: {
1308
+ name?: "none" | "auto" | "default" | "gzip" | "brotli" | "zstd" | null;
1309
+ }[];
1310
+ } | null;
1311
+ categories?: string[] | null;
1312
+ description?: string | null;
1313
+ enabled?: boolean | null;
1314
+ exposedCredentialCheck?: {
1315
+ passwordExpression: string;
1316
+ usernameExpression: string;
1317
+ } | null;
1318
+ expression?: string | null;
1319
+ logging?: {
1320
+ enabled: boolean;
1321
+ } | null;
1322
+ ratelimit?: {
1323
+ characteristics: string[];
1324
+ period: number;
1325
+ countingExpression?: string | null;
1326
+ mitigationTimeout?: number | null;
1327
+ requestsPerPeriod?: number | null;
1328
+ requestsToOrigin?: boolean | null;
1329
+ scorePerPeriod?: number | null;
1330
+ scoreResponseHeaderName?: string | null;
1331
+ } | null;
1332
+ ref?: string | null;
1333
+ } | {
1334
+ accountId?: string | null;
1335
+ zoneId?: string | null;
1336
+ id?: string | null;
1337
+ action?: "ddos_dynamic" | null;
1338
+ actionParameters?: unknown | null;
1339
+ description?: string | null;
1340
+ enabled?: boolean | null;
1341
+ exposedCredentialCheck?: {
1342
+ passwordExpression: string;
1343
+ usernameExpression: string;
1344
+ } | null;
1345
+ expression?: string | null;
1346
+ logging?: {
1347
+ enabled: boolean;
1348
+ } | null;
1349
+ position?: {
1350
+ before?: string | null;
1351
+ } | {
1352
+ after?: string | null;
1353
+ } | {
1354
+ index?: number | null;
1355
+ } | null;
1356
+ ratelimit?: {
1357
+ characteristics: string[];
1358
+ period: number;
1359
+ countingExpression?: string | null;
1360
+ mitigationTimeout?: number | null;
1361
+ requestsPerPeriod?: number | null;
1362
+ requestsToOrigin?: boolean | null;
1363
+ scorePerPeriod?: number | null;
1364
+ scoreResponseHeaderName?: string | null;
1365
+ } | null;
1366
+ ref?: string | null;
1367
+ } | {
1368
+ accountId?: string | null;
1369
+ zoneId?: string | null;
1370
+ id?: string | null;
1371
+ action?: "execute" | null;
1372
+ actionParameters?: {
1373
+ id: string;
1374
+ matchedData?: {
1375
+ publicKey: string;
1376
+ } | null;
1377
+ overrides?: {
1378
+ action?: string | null;
1379
+ categories?: {
1380
+ category: string;
1381
+ action?: string | null;
1382
+ enabled?: boolean | null;
1383
+ sensitivityLevel?: "default" | "medium" | "low" | "eoff" | null;
1384
+ }[] | null;
1385
+ enabled?: boolean | null;
1386
+ rules?: {
1387
+ id: string;
1388
+ action?: string | null;
1389
+ enabled?: boolean | null;
1390
+ scoreThreshold?: number | null;
1391
+ sensitivityLevel?: "default" | "medium" | "low" | "eoff" | null;
1392
+ }[] | null;
1393
+ sensitivityLevel?: "default" | "medium" | "low" | "eoff" | null;
1394
+ } | null;
1395
+ } | null;
1396
+ description?: string | null;
1397
+ enabled?: boolean | null;
1398
+ exposedCredentialCheck?: {
1399
+ passwordExpression: string;
1400
+ usernameExpression: string;
1401
+ } | null;
1402
+ expression?: string | null;
1403
+ logging?: {
1404
+ enabled: boolean;
1405
+ } | null;
1406
+ position?: {
1407
+ before?: string | null;
1408
+ } | {
1409
+ after?: string | null;
1410
+ } | {
1411
+ index?: number | null;
1412
+ } | null;
1413
+ ratelimit?: {
1414
+ characteristics: string[];
1415
+ period: number;
1416
+ countingExpression?: string | null;
1417
+ mitigationTimeout?: number | null;
1418
+ requestsPerPeriod?: number | null;
1419
+ requestsToOrigin?: boolean | null;
1420
+ scorePerPeriod?: number | null;
1421
+ scoreResponseHeaderName?: string | null;
1422
+ } | null;
1423
+ ref?: string | null;
1424
+ } | {
1425
+ accountId?: string | null;
1426
+ zoneId?: string | null;
1427
+ id?: string | null;
1428
+ action?: "force_connection_close" | null;
1429
+ actionParameters?: unknown | null;
1430
+ description?: string | null;
1431
+ enabled?: boolean | null;
1432
+ exposedCredentialCheck?: {
1433
+ passwordExpression: string;
1434
+ usernameExpression: string;
1435
+ } | null;
1436
+ expression?: string | null;
1437
+ logging?: {
1438
+ enabled: boolean;
1439
+ } | null;
1440
+ position?: {
1441
+ before?: string | null;
1442
+ } | {
1443
+ after?: string | null;
1444
+ } | {
1445
+ index?: number | null;
1446
+ } | null;
1447
+ ratelimit?: {
1448
+ characteristics: string[];
1449
+ period: number;
1450
+ countingExpression?: string | null;
1451
+ mitigationTimeout?: number | null;
1452
+ requestsPerPeriod?: number | null;
1453
+ requestsToOrigin?: boolean | null;
1454
+ scorePerPeriod?: number | null;
1455
+ scoreResponseHeaderName?: string | null;
1456
+ } | null;
1457
+ ref?: string | null;
1458
+ } | {
1459
+ lastUpdated: string;
1460
+ version: string;
1461
+ id?: string | null;
1462
+ action?: "js_challenge" | null;
1463
+ actionParameters?: unknown | null;
1464
+ categories?: string[] | null;
1465
+ description?: string | null;
1466
+ enabled?: boolean | null;
1467
+ exposedCredentialCheck?: {
1468
+ passwordExpression: string;
1469
+ usernameExpression: string;
1470
+ } | null;
1471
+ expression?: string | null;
1472
+ logging?: unknown | null;
1473
+ ratelimit?: {
1474
+ characteristics: string[];
1475
+ period: number;
1476
+ countingExpression?: string | null;
1477
+ mitigationTimeout?: number | null;
1478
+ requestsPerPeriod?: number | null;
1479
+ requestsToOrigin?: boolean | null;
1480
+ scorePerPeriod?: number | null;
1481
+ scoreResponseHeaderName?: string | null;
1482
+ } | null;
1483
+ ref?: string | null;
1484
+ } | {
1485
+ accountId?: string | null;
1486
+ zoneId?: string | null;
1487
+ id?: string | null;
1488
+ action?: "log" | null;
1489
+ actionParameters?: unknown | null;
1490
+ description?: string | null;
1491
+ enabled?: boolean | null;
1492
+ exposedCredentialCheck?: {
1493
+ passwordExpression: string;
1494
+ usernameExpression: string;
1495
+ } | null;
1496
+ expression?: string | null;
1497
+ logging?: {
1498
+ enabled: boolean;
1499
+ } | null;
1500
+ position?: {
1501
+ before?: string | null;
1502
+ } | {
1503
+ after?: string | null;
1504
+ } | {
1505
+ index?: number | null;
1506
+ } | null;
1507
+ ratelimit?: {
1508
+ characteristics: string[];
1509
+ period: number;
1510
+ countingExpression?: string | null;
1511
+ mitigationTimeout?: number | null;
1512
+ requestsPerPeriod?: number | null;
1513
+ requestsToOrigin?: boolean | null;
1514
+ scorePerPeriod?: number | null;
1515
+ scoreResponseHeaderName?: string | null;
1516
+ } | null;
1517
+ ref?: string | null;
1518
+ } | {
1519
+ accountId?: string | null;
1520
+ zoneId?: string | null;
1521
+ id?: string | null;
1522
+ action?: "log_custom_field" | null;
1523
+ actionParameters?: {
1524
+ cookieFields?: {
1525
+ name: string;
1526
+ }[] | null;
1527
+ rawResponseFields?: {
1528
+ name: string;
1529
+ preserveDuplicates?: boolean | null;
1530
+ }[] | null;
1531
+ requestFields?: {
1532
+ name: string;
1533
+ }[] | null;
1534
+ responseFields?: {
1535
+ name: string;
1536
+ preserveDuplicates?: boolean | null;
1537
+ }[] | null;
1538
+ transformedRequestFields?: {
1539
+ name: string;
1540
+ }[] | null;
1541
+ } | null;
1542
+ description?: string | null;
1543
+ enabled?: boolean | null;
1544
+ exposedCredentialCheck?: {
1545
+ passwordExpression: string;
1546
+ usernameExpression: string;
1547
+ } | null;
1548
+ expression?: string | null;
1549
+ logging?: {
1550
+ enabled: boolean;
1551
+ } | null;
1552
+ position?: {
1553
+ before?: string | null;
1554
+ } | {
1555
+ after?: string | null;
1556
+ } | {
1557
+ index?: number | null;
1558
+ } | null;
1559
+ ratelimit?: {
1560
+ characteristics: string[];
1561
+ period: number;
1562
+ countingExpression?: string | null;
1563
+ mitigationTimeout?: number | null;
1564
+ requestsPerPeriod?: number | null;
1565
+ requestsToOrigin?: boolean | null;
1566
+ scorePerPeriod?: number | null;
1567
+ scoreResponseHeaderName?: string | null;
1568
+ } | null;
1569
+ ref?: string | null;
1570
+ } | {
1571
+ accountId?: string | null;
1572
+ zoneId?: string | null;
1573
+ id?: string | null;
1574
+ action?: "managed_challenge" | null;
1575
+ actionParameters?: unknown | null;
1576
+ description?: string | null;
1577
+ enabled?: boolean | null;
1578
+ exposedCredentialCheck?: {
1579
+ passwordExpression: string;
1580
+ usernameExpression: string;
1581
+ } | null;
1582
+ expression?: string | null;
1583
+ logging?: {
1584
+ enabled: boolean;
1585
+ } | null;
1586
+ position?: {
1587
+ before?: string | null;
1588
+ } | {
1589
+ after?: string | null;
1590
+ } | {
1591
+ index?: number | null;
1592
+ } | null;
1593
+ ratelimit?: {
1594
+ characteristics: string[];
1595
+ period: number;
1596
+ countingExpression?: string | null;
1597
+ mitigationTimeout?: number | null;
1598
+ requestsPerPeriod?: number | null;
1599
+ requestsToOrigin?: boolean | null;
1600
+ scorePerPeriod?: number | null;
1601
+ scoreResponseHeaderName?: string | null;
1602
+ } | null;
1603
+ ref?: string | null;
1604
+ } | {
1605
+ accountId?: string | null;
1606
+ zoneId?: string | null;
1607
+ id?: string | null;
1608
+ action?: "redirect" | null;
1609
+ actionParameters?: {
1610
+ fromList?: {
1611
+ key: string;
1612
+ name: string;
1613
+ } | null;
1614
+ fromValue?: {
1615
+ targetUrl: {
1616
+ expression?: string | null;
1617
+ value?: string | null;
1618
+ };
1619
+ preserveQueryString?: boolean | null;
1620
+ statusCode?: "301" | "302" | "303" | "307" | "308" | null;
1621
+ } | null;
1622
+ } | null;
1623
+ description?: string | null;
1624
+ enabled?: boolean | null;
1625
+ exposedCredentialCheck?: {
1626
+ passwordExpression: string;
1627
+ usernameExpression: string;
1628
+ } | null;
1629
+ expression?: string | null;
1630
+ logging?: {
1631
+ enabled: boolean;
1632
+ } | null;
1633
+ position?: {
1634
+ before?: string | null;
1635
+ } | {
1636
+ after?: string | null;
1637
+ } | {
1638
+ index?: number | null;
1639
+ } | null;
1640
+ ratelimit?: {
1641
+ characteristics: string[];
1642
+ period: number;
1643
+ countingExpression?: string | null;
1644
+ mitigationTimeout?: number | null;
1645
+ requestsPerPeriod?: number | null;
1646
+ requestsToOrigin?: boolean | null;
1647
+ scorePerPeriod?: number | null;
1648
+ scoreResponseHeaderName?: string | null;
1649
+ } | null;
1650
+ ref?: string | null;
1651
+ } | {
1652
+ accountId?: string | null;
1653
+ zoneId?: string | null;
1654
+ id?: string | null;
1655
+ action?: "rewrite" | null;
1656
+ actionParameters?: {
1657
+ headers?: Record<string, unknown> | null;
1658
+ uri?: {
1659
+ path: {
1660
+ expression?: string | null;
1661
+ value?: string | null;
1662
+ };
1663
+ } | {
1664
+ query: {
1665
+ expression?: string | null;
1666
+ value?: string | null;
1667
+ };
1668
+ } | null;
1669
+ } | null;
1670
+ description?: string | null;
1671
+ enabled?: boolean | null;
1672
+ exposedCredentialCheck?: {
1673
+ passwordExpression: string;
1674
+ usernameExpression: string;
1675
+ } | null;
1676
+ expression?: string | null;
1677
+ logging?: {
1678
+ enabled: boolean;
1679
+ } | null;
1680
+ position?: {
1681
+ before?: string | null;
1682
+ } | {
1683
+ after?: string | null;
1684
+ } | {
1685
+ index?: number | null;
1686
+ } | null;
1687
+ ratelimit?: {
1688
+ characteristics: string[];
1689
+ period: number;
1690
+ countingExpression?: string | null;
1691
+ mitigationTimeout?: number | null;
1692
+ requestsPerPeriod?: number | null;
1693
+ requestsToOrigin?: boolean | null;
1694
+ scorePerPeriod?: number | null;
1695
+ scoreResponseHeaderName?: string | null;
1696
+ } | null;
1697
+ ref?: string | null;
1698
+ } | {
1699
+ accountId?: string | null;
1700
+ zoneId?: string | null;
1701
+ id?: string | null;
1702
+ action?: "route" | null;
1703
+ actionParameters?: {
1704
+ hostHeader?: string | null;
1705
+ origin?: {
1706
+ host?: string | null;
1707
+ port?: number | null;
1708
+ } | null;
1709
+ sni?: {
1710
+ value: string;
1711
+ } | null;
1712
+ } | null;
1713
+ description?: string | null;
1714
+ enabled?: boolean | null;
1715
+ exposedCredentialCheck?: {
1716
+ passwordExpression: string;
1717
+ usernameExpression: string;
1718
+ } | null;
1719
+ expression?: string | null;
1720
+ logging?: {
1721
+ enabled: boolean;
1722
+ } | null;
1723
+ position?: {
1724
+ before?: string | null;
1725
+ } | {
1726
+ after?: string | null;
1727
+ } | {
1728
+ index?: number | null;
1729
+ } | null;
1730
+ ratelimit?: {
1731
+ characteristics: string[];
1732
+ period: number;
1733
+ countingExpression?: string | null;
1734
+ mitigationTimeout?: number | null;
1735
+ requestsPerPeriod?: number | null;
1736
+ requestsToOrigin?: boolean | null;
1737
+ scorePerPeriod?: number | null;
1738
+ scoreResponseHeaderName?: string | null;
1739
+ } | null;
1740
+ ref?: string | null;
1741
+ } | {
1742
+ accountId?: string | null;
1743
+ zoneId?: string | null;
1744
+ id?: string | null;
1745
+ action?: "score" | null;
1746
+ actionParameters?: {
1747
+ increment: number;
1748
+ } | null;
1749
+ description?: string | null;
1750
+ enabled?: boolean | null;
1751
+ exposedCredentialCheck?: {
1752
+ passwordExpression: string;
1753
+ usernameExpression: string;
1754
+ } | null;
1755
+ expression?: string | null;
1756
+ logging?: {
1757
+ enabled: boolean;
1758
+ } | null;
1759
+ position?: {
1760
+ before?: string | null;
1761
+ } | {
1762
+ after?: string | null;
1763
+ } | {
1764
+ index?: number | null;
1765
+ } | null;
1766
+ ratelimit?: {
1767
+ characteristics: string[];
1768
+ period: number;
1769
+ countingExpression?: string | null;
1770
+ mitigationTimeout?: number | null;
1771
+ requestsPerPeriod?: number | null;
1772
+ requestsToOrigin?: boolean | null;
1773
+ scorePerPeriod?: number | null;
1774
+ scoreResponseHeaderName?: string | null;
1775
+ } | null;
1776
+ ref?: string | null;
1777
+ } | {
1778
+ accountId?: string | null;
1779
+ zoneId?: string | null;
1780
+ id?: string | null;
1781
+ action?: "serve_error" | null;
1782
+ actionParameters?: {
1783
+ content: string;
1784
+ contentType?: "application/json" | "text/html" | "text/plain" | "text/xml" | null;
1785
+ statusCode?: number | null;
1786
+ } | {
1787
+ assetName: string;
1788
+ contentType?: "application/json" | "text/html" | "text/plain" | "text/xml" | null;
1789
+ statusCode?: number | null;
1790
+ } | null;
1791
+ description?: string | null;
1792
+ enabled?: boolean | null;
1793
+ exposedCredentialCheck?: {
1794
+ passwordExpression: string;
1795
+ usernameExpression: string;
1796
+ } | null;
1797
+ expression?: string | null;
1798
+ logging?: {
1799
+ enabled: boolean;
1800
+ } | null;
1801
+ position?: {
1802
+ before?: string | null;
1803
+ } | {
1804
+ after?: string | null;
1805
+ } | {
1806
+ index?: number | null;
1807
+ } | null;
1808
+ ratelimit?: {
1809
+ characteristics: string[];
1810
+ period: number;
1811
+ countingExpression?: string | null;
1812
+ mitigationTimeout?: number | null;
1813
+ requestsPerPeriod?: number | null;
1814
+ requestsToOrigin?: boolean | null;
1815
+ scorePerPeriod?: number | null;
1816
+ scoreResponseHeaderName?: string | null;
1817
+ } | null;
1818
+ ref?: string | null;
1819
+ } | {
1820
+ accountId?: string | null;
1821
+ zoneId?: string | null;
1822
+ id?: string | null;
1823
+ action?: "set_cache_settings" | null;
1824
+ actionParameters?: {
1825
+ additionalCacheablePorts?: number[] | null;
1826
+ browserTtl?: {
1827
+ mode: "respect_origin" | "bypass_by_default" | "override_origin" | "bypass";
1828
+ default?: number | null;
1829
+ } | null;
1830
+ cache?: boolean | null;
1831
+ cacheKey?: {
1832
+ cacheByDeviceType?: boolean | null;
1833
+ cacheDeceptionArmor?: boolean | null;
1834
+ customKey?: {
1835
+ cookie?: {
1836
+ checkPresence?: string[] | null;
1837
+ include?: string[] | null;
1838
+ } | null;
1839
+ header?: {
1840
+ checkPresence?: string[] | null;
1841
+ contains?: Record<string, unknown> | null;
1842
+ excludeOrigin?: boolean | null;
1843
+ include?: string[] | null;
1844
+ } | null;
1845
+ host?: {
1846
+ resolved?: boolean | null;
1847
+ } | null;
1848
+ queryString?: {
1849
+ exclude?: {
1850
+ all?: true | null;
1851
+ list?: string[] | null;
1852
+ } | null;
1853
+ include?: {
1854
+ all?: true | null;
1855
+ list?: string[] | null;
1856
+ } | null;
1857
+ } | null;
1858
+ user?: {
1859
+ deviceType?: boolean | null;
1860
+ geo?: boolean | null;
1861
+ lang?: boolean | null;
1862
+ } | null;
1863
+ } | null;
1864
+ ignoreQueryStringsOrder?: boolean | null;
1865
+ } | null;
1866
+ cacheReserve?: {
1867
+ eligible: boolean;
1868
+ minimumFileSize?: number | null;
1869
+ } | null;
1870
+ edgeTtl?: {
1871
+ mode: "respect_origin" | "bypass_by_default" | "override_origin";
1872
+ default?: number | null;
1873
+ statusCodeTtl?: {
1874
+ value: number;
1875
+ statusCode?: number | null;
1876
+ statusCodeRange?: {
1877
+ from?: number | null;
1878
+ to?: number | null;
1879
+ } | null;
1880
+ }[] | null;
1881
+ } | null;
1882
+ originCacheControl?: boolean | null;
1883
+ originErrorPagePassthru?: boolean | null;
1884
+ readTimeout?: number | null;
1885
+ respectStrongEtags?: boolean | null;
1886
+ serveStale?: {
1887
+ disableStaleWhileUpdating?: boolean | null;
1888
+ } | null;
1889
+ } | null;
1890
+ description?: string | null;
1891
+ enabled?: boolean | null;
1892
+ exposedCredentialCheck?: {
1893
+ passwordExpression: string;
1894
+ usernameExpression: string;
1895
+ } | null;
1896
+ expression?: string | null;
1897
+ logging?: {
1898
+ enabled: boolean;
1899
+ } | null;
1900
+ position?: {
1901
+ before?: string | null;
1902
+ } | {
1903
+ after?: string | null;
1904
+ } | {
1905
+ index?: number | null;
1906
+ } | null;
1907
+ ratelimit?: {
1908
+ characteristics: string[];
1909
+ period: number;
1910
+ countingExpression?: string | null;
1911
+ mitigationTimeout?: number | null;
1912
+ requestsPerPeriod?: number | null;
1913
+ requestsToOrigin?: boolean | null;
1914
+ scorePerPeriod?: number | null;
1915
+ scoreResponseHeaderName?: string | null;
1916
+ } | null;
1917
+ ref?: string | null;
1918
+ } | {
1919
+ lastUpdated: string;
1920
+ version: string;
1921
+ id?: string | null;
1922
+ action?: "set_config" | null;
1923
+ actionParameters?: {
1924
+ automaticHttpsRewrites?: boolean | null;
1925
+ autominify?: {
1926
+ css?: boolean | null;
1927
+ html?: boolean | null;
1928
+ js?: boolean | null;
1929
+ } | null;
1930
+ bic?: boolean | null;
1931
+ disableApps?: true | null;
1932
+ disablePayPerCrawl?: true | null;
1933
+ disableRum?: true | null;
1934
+ disableZaraz?: true | null;
1935
+ emailObfuscation?: boolean | null;
1936
+ fonts?: boolean | null;
1937
+ hotlinkProtection?: boolean | null;
1938
+ mirage?: boolean | null;
1939
+ opportunisticEncryption?: boolean | null;
1940
+ polish?: "off" | "lossless" | "lossy" | "webp" | null;
1941
+ requestBodyBuffering?: "none" | "standard" | "full" | null;
1942
+ responseBodyBuffering?: "none" | "standard" | null;
1943
+ rocketLoader?: boolean | null;
1944
+ securityLevel?: "off" | "essentially_off" | "low" | "medium" | "high" | "under_attack" | null;
1945
+ serverSideExcludes?: boolean | null;
1946
+ ssl?: "off" | "flexible" | "full" | "strict" | "origin_pull" | null;
1947
+ sxg?: boolean | null;
1948
+ } | null;
1949
+ categories?: string[] | null;
1950
+ description?: string | null;
1951
+ enabled?: boolean | null;
1952
+ exposedCredentialCheck?: {
1953
+ passwordExpression: string;
1954
+ usernameExpression: string;
1955
+ } | null;
1956
+ expression?: string | null;
1957
+ logging?: {
1958
+ enabled: boolean;
1959
+ } | null;
1960
+ ratelimit?: {
1961
+ characteristics: string[];
1962
+ period: number;
1963
+ countingExpression?: string | null;
1964
+ mitigationTimeout?: number | null;
1965
+ requestsPerPeriod?: number | null;
1966
+ requestsToOrigin?: boolean | null;
1967
+ scorePerPeriod?: number | null;
1968
+ scoreResponseHeaderName?: string | null;
1969
+ } | null;
1970
+ ref?: string | null;
1971
+ } | {
1972
+ accountId?: string | null;
1973
+ zoneId?: string | null;
1974
+ id?: string | null;
1975
+ action?: "skip" | null;
1976
+ actionParameters?: {
1977
+ phase?: "current" | null;
1978
+ phases?: ("ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit")[] | null;
1979
+ products?: ("bic" | "hot" | "rateLimit" | "securityLevel" | "uaBlock" | "waf" | "zoneLockdown")[] | null;
1980
+ rules?: Record<string, unknown> | null;
1981
+ ruleset?: "current" | null;
1982
+ rulesets?: string[] | null;
1983
+ } | null;
1984
+ description?: string | null;
1985
+ enabled?: boolean | null;
1986
+ exposedCredentialCheck?: {
1987
+ passwordExpression: string;
1988
+ usernameExpression: string;
1989
+ } | null;
1990
+ expression?: string | null;
1991
+ logging?: {
1992
+ enabled: boolean;
1993
+ } | null;
1994
+ position?: {
1995
+ before?: string | null;
1996
+ } | {
1997
+ after?: string | null;
1998
+ } | {
1999
+ index?: number | null;
2000
+ } | null;
2001
+ ratelimit?: {
2002
+ characteristics: string[];
2003
+ period: number;
2004
+ countingExpression?: string | null;
2005
+ mitigationTimeout?: number | null;
2006
+ requestsPerPeriod?: number | null;
2007
+ requestsToOrigin?: boolean | null;
2008
+ scorePerPeriod?: number | null;
2009
+ scoreResponseHeaderName?: string | null;
2010
+ } | null;
2011
+ ref?: string | null;
2012
+ })[];
2013
+ /** The version of the ruleset. */
2014
+ version: string;
2015
+ /** An informative description of the ruleset. */
2016
+ description?: string | null;
2017
+ }
2018
+ export declare const PatchRuleResponse: Schema.Schema<PatchRuleResponse>;
2019
+ export type PatchRuleError = DefaultErrors;
2020
+ export declare const patchRule: API.OperationMethod<PatchRuleRequest, PatchRuleResponse, PatchRuleError, Credentials | HttpClient.HttpClient>;
2021
+ export interface DeleteRuleRequest {
2022
+ rulesetId: string;
2023
+ ruleId: string;
2024
+ }
2025
+ export declare const DeleteRuleRequest: Schema.Schema<DeleteRuleRequest>;
2026
+ export interface DeleteRuleResponse {
2027
+ /** The unique ID of the ruleset. */
2028
+ id: string;
2029
+ /** The kind of the ruleset. */
2030
+ kind: "zone" | "managed" | "custom" | "root";
2031
+ /** The timestamp of when the ruleset was last modified. */
2032
+ lastUpdated: string;
2033
+ /** The human-readable name of the ruleset. */
2034
+ name: string;
2035
+ /** The phase of the ruleset. */
2036
+ phase: "ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit";
2037
+ /** The list of rules in the ruleset. */
2038
+ rules: ({
2039
+ accountId?: string | null;
2040
+ zoneId?: string | null;
2041
+ id?: string | null;
2042
+ action?: "block" | null;
2043
+ actionParameters?: {
2044
+ response?: {
2045
+ content: string;
2046
+ contentType: string;
2047
+ statusCode: number;
2048
+ } | null;
2049
+ } | null;
2050
+ description?: string | null;
2051
+ enabled?: boolean | null;
2052
+ exposedCredentialCheck?: {
2053
+ passwordExpression: string;
2054
+ usernameExpression: string;
2055
+ } | null;
2056
+ expression?: string | null;
2057
+ logging?: {
2058
+ enabled: boolean;
2059
+ } | null;
2060
+ position?: {
2061
+ before?: string | null;
2062
+ } | {
2063
+ after?: string | null;
2064
+ } | {
2065
+ index?: number | null;
2066
+ } | null;
2067
+ ratelimit?: {
2068
+ characteristics: string[];
2069
+ period: number;
2070
+ countingExpression?: string | null;
2071
+ mitigationTimeout?: number | null;
2072
+ requestsPerPeriod?: number | null;
2073
+ requestsToOrigin?: boolean | null;
2074
+ scorePerPeriod?: number | null;
2075
+ scoreResponseHeaderName?: string | null;
2076
+ } | null;
2077
+ ref?: string | null;
2078
+ } | {
2079
+ lastUpdated: string;
2080
+ version: string;
2081
+ id?: string | null;
2082
+ action?: "challenge" | null;
2083
+ actionParameters?: unknown | null;
2084
+ categories?: string[] | null;
2085
+ description?: string | null;
2086
+ enabled?: boolean | null;
2087
+ exposedCredentialCheck?: {
2088
+ passwordExpression: string;
2089
+ usernameExpression: string;
2090
+ } | null;
2091
+ expression?: string | null;
2092
+ logging?: unknown | null;
2093
+ ratelimit?: {
2094
+ characteristics: string[];
2095
+ period: number;
2096
+ countingExpression?: string | null;
2097
+ mitigationTimeout?: number | null;
2098
+ requestsPerPeriod?: number | null;
2099
+ requestsToOrigin?: boolean | null;
2100
+ scorePerPeriod?: number | null;
2101
+ scoreResponseHeaderName?: string | null;
2102
+ } | null;
2103
+ ref?: string | null;
2104
+ } | {
2105
+ lastUpdated: string;
2106
+ version: string;
2107
+ id?: string | null;
2108
+ action?: "compress_response" | null;
2109
+ actionParameters?: {
2110
+ algorithms: {
2111
+ name?: "none" | "auto" | "default" | "gzip" | "brotli" | "zstd" | null;
2112
+ }[];
2113
+ } | null;
2114
+ categories?: string[] | null;
2115
+ description?: string | null;
2116
+ enabled?: boolean | null;
2117
+ exposedCredentialCheck?: {
2118
+ passwordExpression: string;
2119
+ usernameExpression: string;
2120
+ } | null;
2121
+ expression?: string | null;
2122
+ logging?: {
2123
+ enabled: boolean;
2124
+ } | null;
2125
+ ratelimit?: {
2126
+ characteristics: string[];
2127
+ period: number;
2128
+ countingExpression?: string | null;
2129
+ mitigationTimeout?: number | null;
2130
+ requestsPerPeriod?: number | null;
2131
+ requestsToOrigin?: boolean | null;
2132
+ scorePerPeriod?: number | null;
2133
+ scoreResponseHeaderName?: string | null;
2134
+ } | null;
2135
+ ref?: string | null;
2136
+ } | {
2137
+ accountId?: string | null;
2138
+ zoneId?: string | null;
2139
+ id?: string | null;
2140
+ action?: "ddos_dynamic" | null;
2141
+ actionParameters?: unknown | null;
2142
+ description?: string | null;
2143
+ enabled?: boolean | null;
2144
+ exposedCredentialCheck?: {
2145
+ passwordExpression: string;
2146
+ usernameExpression: string;
2147
+ } | null;
2148
+ expression?: string | null;
2149
+ logging?: {
2150
+ enabled: boolean;
2151
+ } | null;
2152
+ position?: {
2153
+ before?: string | null;
2154
+ } | {
2155
+ after?: string | null;
2156
+ } | {
2157
+ index?: number | null;
2158
+ } | null;
2159
+ ratelimit?: {
2160
+ characteristics: string[];
2161
+ period: number;
2162
+ countingExpression?: string | null;
2163
+ mitigationTimeout?: number | null;
2164
+ requestsPerPeriod?: number | null;
2165
+ requestsToOrigin?: boolean | null;
2166
+ scorePerPeriod?: number | null;
2167
+ scoreResponseHeaderName?: string | null;
2168
+ } | null;
2169
+ ref?: string | null;
2170
+ } | {
2171
+ accountId?: string | null;
2172
+ zoneId?: string | null;
2173
+ id?: string | null;
2174
+ action?: "execute" | null;
2175
+ actionParameters?: {
2176
+ id: string;
2177
+ matchedData?: {
2178
+ publicKey: string;
2179
+ } | null;
2180
+ overrides?: {
2181
+ action?: string | null;
2182
+ categories?: {
2183
+ category: string;
2184
+ action?: string | null;
2185
+ enabled?: boolean | null;
2186
+ sensitivityLevel?: "default" | "medium" | "low" | "eoff" | null;
2187
+ }[] | null;
2188
+ enabled?: boolean | null;
2189
+ rules?: {
2190
+ id: string;
2191
+ action?: string | null;
2192
+ enabled?: boolean | null;
2193
+ scoreThreshold?: number | null;
2194
+ sensitivityLevel?: "default" | "medium" | "low" | "eoff" | null;
2195
+ }[] | null;
2196
+ sensitivityLevel?: "default" | "medium" | "low" | "eoff" | null;
2197
+ } | null;
2198
+ } | null;
2199
+ description?: string | null;
2200
+ enabled?: boolean | null;
2201
+ exposedCredentialCheck?: {
2202
+ passwordExpression: string;
2203
+ usernameExpression: string;
2204
+ } | null;
2205
+ expression?: string | null;
2206
+ logging?: {
2207
+ enabled: boolean;
2208
+ } | null;
2209
+ position?: {
2210
+ before?: string | null;
2211
+ } | {
2212
+ after?: string | null;
2213
+ } | {
2214
+ index?: number | null;
2215
+ } | null;
2216
+ ratelimit?: {
2217
+ characteristics: string[];
2218
+ period: number;
2219
+ countingExpression?: string | null;
2220
+ mitigationTimeout?: number | null;
2221
+ requestsPerPeriod?: number | null;
2222
+ requestsToOrigin?: boolean | null;
2223
+ scorePerPeriod?: number | null;
2224
+ scoreResponseHeaderName?: string | null;
2225
+ } | null;
2226
+ ref?: string | null;
2227
+ } | {
2228
+ accountId?: string | null;
2229
+ zoneId?: string | null;
2230
+ id?: string | null;
2231
+ action?: "force_connection_close" | null;
2232
+ actionParameters?: unknown | null;
2233
+ description?: string | null;
2234
+ enabled?: boolean | null;
2235
+ exposedCredentialCheck?: {
2236
+ passwordExpression: string;
2237
+ usernameExpression: string;
2238
+ } | null;
2239
+ expression?: string | null;
2240
+ logging?: {
2241
+ enabled: boolean;
2242
+ } | null;
2243
+ position?: {
2244
+ before?: string | null;
2245
+ } | {
2246
+ after?: string | null;
2247
+ } | {
2248
+ index?: number | null;
2249
+ } | null;
2250
+ ratelimit?: {
2251
+ characteristics: string[];
2252
+ period: number;
2253
+ countingExpression?: string | null;
2254
+ mitigationTimeout?: number | null;
2255
+ requestsPerPeriod?: number | null;
2256
+ requestsToOrigin?: boolean | null;
2257
+ scorePerPeriod?: number | null;
2258
+ scoreResponseHeaderName?: string | null;
2259
+ } | null;
2260
+ ref?: string | null;
2261
+ } | {
2262
+ lastUpdated: string;
2263
+ version: string;
2264
+ id?: string | null;
2265
+ action?: "js_challenge" | null;
2266
+ actionParameters?: unknown | null;
2267
+ categories?: string[] | null;
2268
+ description?: string | null;
2269
+ enabled?: boolean | null;
2270
+ exposedCredentialCheck?: {
2271
+ passwordExpression: string;
2272
+ usernameExpression: string;
2273
+ } | null;
2274
+ expression?: string | null;
2275
+ logging?: unknown | null;
2276
+ ratelimit?: {
2277
+ characteristics: string[];
2278
+ period: number;
2279
+ countingExpression?: string | null;
2280
+ mitigationTimeout?: number | null;
2281
+ requestsPerPeriod?: number | null;
2282
+ requestsToOrigin?: boolean | null;
2283
+ scorePerPeriod?: number | null;
2284
+ scoreResponseHeaderName?: string | null;
2285
+ } | null;
2286
+ ref?: string | null;
2287
+ } | {
2288
+ accountId?: string | null;
2289
+ zoneId?: string | null;
2290
+ id?: string | null;
2291
+ action?: "log" | null;
2292
+ actionParameters?: unknown | null;
2293
+ description?: string | null;
2294
+ enabled?: boolean | null;
2295
+ exposedCredentialCheck?: {
2296
+ passwordExpression: string;
2297
+ usernameExpression: string;
2298
+ } | null;
2299
+ expression?: string | null;
2300
+ logging?: {
2301
+ enabled: boolean;
2302
+ } | null;
2303
+ position?: {
2304
+ before?: string | null;
2305
+ } | {
2306
+ after?: string | null;
2307
+ } | {
2308
+ index?: number | null;
2309
+ } | null;
2310
+ ratelimit?: {
2311
+ characteristics: string[];
2312
+ period: number;
2313
+ countingExpression?: string | null;
2314
+ mitigationTimeout?: number | null;
2315
+ requestsPerPeriod?: number | null;
2316
+ requestsToOrigin?: boolean | null;
2317
+ scorePerPeriod?: number | null;
2318
+ scoreResponseHeaderName?: string | null;
2319
+ } | null;
2320
+ ref?: string | null;
2321
+ } | {
2322
+ accountId?: string | null;
2323
+ zoneId?: string | null;
2324
+ id?: string | null;
2325
+ action?: "log_custom_field" | null;
2326
+ actionParameters?: {
2327
+ cookieFields?: {
2328
+ name: string;
2329
+ }[] | null;
2330
+ rawResponseFields?: {
2331
+ name: string;
2332
+ preserveDuplicates?: boolean | null;
2333
+ }[] | null;
2334
+ requestFields?: {
2335
+ name: string;
2336
+ }[] | null;
2337
+ responseFields?: {
2338
+ name: string;
2339
+ preserveDuplicates?: boolean | null;
2340
+ }[] | null;
2341
+ transformedRequestFields?: {
2342
+ name: string;
2343
+ }[] | null;
2344
+ } | null;
2345
+ description?: string | null;
2346
+ enabled?: boolean | null;
2347
+ exposedCredentialCheck?: {
2348
+ passwordExpression: string;
2349
+ usernameExpression: string;
2350
+ } | null;
2351
+ expression?: string | null;
2352
+ logging?: {
2353
+ enabled: boolean;
2354
+ } | null;
2355
+ position?: {
2356
+ before?: string | null;
2357
+ } | {
2358
+ after?: string | null;
2359
+ } | {
2360
+ index?: number | null;
2361
+ } | null;
2362
+ ratelimit?: {
2363
+ characteristics: string[];
2364
+ period: number;
2365
+ countingExpression?: string | null;
2366
+ mitigationTimeout?: number | null;
2367
+ requestsPerPeriod?: number | null;
2368
+ requestsToOrigin?: boolean | null;
2369
+ scorePerPeriod?: number | null;
2370
+ scoreResponseHeaderName?: string | null;
2371
+ } | null;
2372
+ ref?: string | null;
2373
+ } | {
2374
+ accountId?: string | null;
2375
+ zoneId?: string | null;
2376
+ id?: string | null;
2377
+ action?: "managed_challenge" | null;
2378
+ actionParameters?: unknown | null;
2379
+ description?: string | null;
2380
+ enabled?: boolean | null;
2381
+ exposedCredentialCheck?: {
2382
+ passwordExpression: string;
2383
+ usernameExpression: string;
2384
+ } | null;
2385
+ expression?: string | null;
2386
+ logging?: {
2387
+ enabled: boolean;
2388
+ } | null;
2389
+ position?: {
2390
+ before?: string | null;
2391
+ } | {
2392
+ after?: string | null;
2393
+ } | {
2394
+ index?: number | null;
2395
+ } | null;
2396
+ ratelimit?: {
2397
+ characteristics: string[];
2398
+ period: number;
2399
+ countingExpression?: string | null;
2400
+ mitigationTimeout?: number | null;
2401
+ requestsPerPeriod?: number | null;
2402
+ requestsToOrigin?: boolean | null;
2403
+ scorePerPeriod?: number | null;
2404
+ scoreResponseHeaderName?: string | null;
2405
+ } | null;
2406
+ ref?: string | null;
2407
+ } | {
2408
+ accountId?: string | null;
2409
+ zoneId?: string | null;
2410
+ id?: string | null;
2411
+ action?: "redirect" | null;
2412
+ actionParameters?: {
2413
+ fromList?: {
2414
+ key: string;
2415
+ name: string;
2416
+ } | null;
2417
+ fromValue?: {
2418
+ targetUrl: {
2419
+ expression?: string | null;
2420
+ value?: string | null;
2421
+ };
2422
+ preserveQueryString?: boolean | null;
2423
+ statusCode?: "301" | "302" | "303" | "307" | "308" | null;
2424
+ } | null;
2425
+ } | null;
2426
+ description?: string | null;
2427
+ enabled?: boolean | null;
2428
+ exposedCredentialCheck?: {
2429
+ passwordExpression: string;
2430
+ usernameExpression: string;
2431
+ } | null;
2432
+ expression?: string | null;
2433
+ logging?: {
2434
+ enabled: boolean;
2435
+ } | null;
2436
+ position?: {
2437
+ before?: string | null;
2438
+ } | {
2439
+ after?: string | null;
2440
+ } | {
2441
+ index?: number | null;
2442
+ } | null;
2443
+ ratelimit?: {
2444
+ characteristics: string[];
2445
+ period: number;
2446
+ countingExpression?: string | null;
2447
+ mitigationTimeout?: number | null;
2448
+ requestsPerPeriod?: number | null;
2449
+ requestsToOrigin?: boolean | null;
2450
+ scorePerPeriod?: number | null;
2451
+ scoreResponseHeaderName?: string | null;
2452
+ } | null;
2453
+ ref?: string | null;
2454
+ } | {
2455
+ accountId?: string | null;
2456
+ zoneId?: string | null;
2457
+ id?: string | null;
2458
+ action?: "rewrite" | null;
2459
+ actionParameters?: {
2460
+ headers?: Record<string, unknown> | null;
2461
+ uri?: {
2462
+ path: {
2463
+ expression?: string | null;
2464
+ value?: string | null;
2465
+ };
2466
+ } | {
2467
+ query: {
2468
+ expression?: string | null;
2469
+ value?: string | null;
2470
+ };
2471
+ } | null;
2472
+ } | null;
2473
+ description?: string | null;
2474
+ enabled?: boolean | null;
2475
+ exposedCredentialCheck?: {
2476
+ passwordExpression: string;
2477
+ usernameExpression: string;
2478
+ } | null;
2479
+ expression?: string | null;
2480
+ logging?: {
2481
+ enabled: boolean;
2482
+ } | null;
2483
+ position?: {
2484
+ before?: string | null;
2485
+ } | {
2486
+ after?: string | null;
2487
+ } | {
2488
+ index?: number | null;
2489
+ } | null;
2490
+ ratelimit?: {
2491
+ characteristics: string[];
2492
+ period: number;
2493
+ countingExpression?: string | null;
2494
+ mitigationTimeout?: number | null;
2495
+ requestsPerPeriod?: number | null;
2496
+ requestsToOrigin?: boolean | null;
2497
+ scorePerPeriod?: number | null;
2498
+ scoreResponseHeaderName?: string | null;
2499
+ } | null;
2500
+ ref?: string | null;
2501
+ } | {
2502
+ accountId?: string | null;
2503
+ zoneId?: string | null;
2504
+ id?: string | null;
2505
+ action?: "route" | null;
2506
+ actionParameters?: {
2507
+ hostHeader?: string | null;
2508
+ origin?: {
2509
+ host?: string | null;
2510
+ port?: number | null;
2511
+ } | null;
2512
+ sni?: {
2513
+ value: string;
2514
+ } | null;
2515
+ } | null;
2516
+ description?: string | null;
2517
+ enabled?: boolean | null;
2518
+ exposedCredentialCheck?: {
2519
+ passwordExpression: string;
2520
+ usernameExpression: string;
2521
+ } | null;
2522
+ expression?: string | null;
2523
+ logging?: {
2524
+ enabled: boolean;
2525
+ } | null;
2526
+ position?: {
2527
+ before?: string | null;
2528
+ } | {
2529
+ after?: string | null;
2530
+ } | {
2531
+ index?: number | null;
2532
+ } | null;
2533
+ ratelimit?: {
2534
+ characteristics: string[];
2535
+ period: number;
2536
+ countingExpression?: string | null;
2537
+ mitigationTimeout?: number | null;
2538
+ requestsPerPeriod?: number | null;
2539
+ requestsToOrigin?: boolean | null;
2540
+ scorePerPeriod?: number | null;
2541
+ scoreResponseHeaderName?: string | null;
2542
+ } | null;
2543
+ ref?: string | null;
2544
+ } | {
2545
+ accountId?: string | null;
2546
+ zoneId?: string | null;
2547
+ id?: string | null;
2548
+ action?: "score" | null;
2549
+ actionParameters?: {
2550
+ increment: number;
2551
+ } | null;
2552
+ description?: string | null;
2553
+ enabled?: boolean | null;
2554
+ exposedCredentialCheck?: {
2555
+ passwordExpression: string;
2556
+ usernameExpression: string;
2557
+ } | null;
2558
+ expression?: string | null;
2559
+ logging?: {
2560
+ enabled: boolean;
2561
+ } | null;
2562
+ position?: {
2563
+ before?: string | null;
2564
+ } | {
2565
+ after?: string | null;
2566
+ } | {
2567
+ index?: number | null;
2568
+ } | null;
2569
+ ratelimit?: {
2570
+ characteristics: string[];
2571
+ period: number;
2572
+ countingExpression?: string | null;
2573
+ mitigationTimeout?: number | null;
2574
+ requestsPerPeriod?: number | null;
2575
+ requestsToOrigin?: boolean | null;
2576
+ scorePerPeriod?: number | null;
2577
+ scoreResponseHeaderName?: string | null;
2578
+ } | null;
2579
+ ref?: string | null;
2580
+ } | {
2581
+ accountId?: string | null;
2582
+ zoneId?: string | null;
2583
+ id?: string | null;
2584
+ action?: "serve_error" | null;
2585
+ actionParameters?: {
2586
+ content: string;
2587
+ contentType?: "application/json" | "text/html" | "text/plain" | "text/xml" | null;
2588
+ statusCode?: number | null;
2589
+ } | {
2590
+ assetName: string;
2591
+ contentType?: "application/json" | "text/html" | "text/plain" | "text/xml" | null;
2592
+ statusCode?: number | null;
2593
+ } | null;
2594
+ description?: string | null;
2595
+ enabled?: boolean | null;
2596
+ exposedCredentialCheck?: {
2597
+ passwordExpression: string;
2598
+ usernameExpression: string;
2599
+ } | null;
2600
+ expression?: string | null;
2601
+ logging?: {
2602
+ enabled: boolean;
2603
+ } | null;
2604
+ position?: {
2605
+ before?: string | null;
2606
+ } | {
2607
+ after?: string | null;
2608
+ } | {
2609
+ index?: number | null;
2610
+ } | null;
2611
+ ratelimit?: {
2612
+ characteristics: string[];
2613
+ period: number;
2614
+ countingExpression?: string | null;
2615
+ mitigationTimeout?: number | null;
2616
+ requestsPerPeriod?: number | null;
2617
+ requestsToOrigin?: boolean | null;
2618
+ scorePerPeriod?: number | null;
2619
+ scoreResponseHeaderName?: string | null;
2620
+ } | null;
2621
+ ref?: string | null;
2622
+ } | {
2623
+ accountId?: string | null;
2624
+ zoneId?: string | null;
2625
+ id?: string | null;
2626
+ action?: "set_cache_settings" | null;
2627
+ actionParameters?: {
2628
+ additionalCacheablePorts?: number[] | null;
2629
+ browserTtl?: {
2630
+ mode: "respect_origin" | "bypass_by_default" | "override_origin" | "bypass";
2631
+ default?: number | null;
2632
+ } | null;
2633
+ cache?: boolean | null;
2634
+ cacheKey?: {
2635
+ cacheByDeviceType?: boolean | null;
2636
+ cacheDeceptionArmor?: boolean | null;
2637
+ customKey?: {
2638
+ cookie?: {
2639
+ checkPresence?: string[] | null;
2640
+ include?: string[] | null;
2641
+ } | null;
2642
+ header?: {
2643
+ checkPresence?: string[] | null;
2644
+ contains?: Record<string, unknown> | null;
2645
+ excludeOrigin?: boolean | null;
2646
+ include?: string[] | null;
2647
+ } | null;
2648
+ host?: {
2649
+ resolved?: boolean | null;
2650
+ } | null;
2651
+ queryString?: {
2652
+ exclude?: {
2653
+ all?: true | null;
2654
+ list?: string[] | null;
2655
+ } | null;
2656
+ include?: {
2657
+ all?: true | null;
2658
+ list?: string[] | null;
2659
+ } | null;
2660
+ } | null;
2661
+ user?: {
2662
+ deviceType?: boolean | null;
2663
+ geo?: boolean | null;
2664
+ lang?: boolean | null;
2665
+ } | null;
2666
+ } | null;
2667
+ ignoreQueryStringsOrder?: boolean | null;
2668
+ } | null;
2669
+ cacheReserve?: {
2670
+ eligible: boolean;
2671
+ minimumFileSize?: number | null;
2672
+ } | null;
2673
+ edgeTtl?: {
2674
+ mode: "respect_origin" | "bypass_by_default" | "override_origin";
2675
+ default?: number | null;
2676
+ statusCodeTtl?: {
2677
+ value: number;
2678
+ statusCode?: number | null;
2679
+ statusCodeRange?: {
2680
+ from?: number | null;
2681
+ to?: number | null;
2682
+ } | null;
2683
+ }[] | null;
2684
+ } | null;
2685
+ originCacheControl?: boolean | null;
2686
+ originErrorPagePassthru?: boolean | null;
2687
+ readTimeout?: number | null;
2688
+ respectStrongEtags?: boolean | null;
2689
+ serveStale?: {
2690
+ disableStaleWhileUpdating?: boolean | null;
2691
+ } | null;
2692
+ } | null;
2693
+ description?: string | null;
2694
+ enabled?: boolean | null;
2695
+ exposedCredentialCheck?: {
2696
+ passwordExpression: string;
2697
+ usernameExpression: string;
2698
+ } | null;
2699
+ expression?: string | null;
2700
+ logging?: {
2701
+ enabled: boolean;
2702
+ } | null;
2703
+ position?: {
2704
+ before?: string | null;
2705
+ } | {
2706
+ after?: string | null;
2707
+ } | {
2708
+ index?: number | null;
2709
+ } | null;
2710
+ ratelimit?: {
2711
+ characteristics: string[];
2712
+ period: number;
2713
+ countingExpression?: string | null;
2714
+ mitigationTimeout?: number | null;
2715
+ requestsPerPeriod?: number | null;
2716
+ requestsToOrigin?: boolean | null;
2717
+ scorePerPeriod?: number | null;
2718
+ scoreResponseHeaderName?: string | null;
2719
+ } | null;
2720
+ ref?: string | null;
2721
+ } | {
2722
+ lastUpdated: string;
2723
+ version: string;
2724
+ id?: string | null;
2725
+ action?: "set_config" | null;
2726
+ actionParameters?: {
2727
+ automaticHttpsRewrites?: boolean | null;
2728
+ autominify?: {
2729
+ css?: boolean | null;
2730
+ html?: boolean | null;
2731
+ js?: boolean | null;
2732
+ } | null;
2733
+ bic?: boolean | null;
2734
+ disableApps?: true | null;
2735
+ disablePayPerCrawl?: true | null;
2736
+ disableRum?: true | null;
2737
+ disableZaraz?: true | null;
2738
+ emailObfuscation?: boolean | null;
2739
+ fonts?: boolean | null;
2740
+ hotlinkProtection?: boolean | null;
2741
+ mirage?: boolean | null;
2742
+ opportunisticEncryption?: boolean | null;
2743
+ polish?: "off" | "lossless" | "lossy" | "webp" | null;
2744
+ requestBodyBuffering?: "none" | "standard" | "full" | null;
2745
+ responseBodyBuffering?: "none" | "standard" | null;
2746
+ rocketLoader?: boolean | null;
2747
+ securityLevel?: "off" | "essentially_off" | "low" | "medium" | "high" | "under_attack" | null;
2748
+ serverSideExcludes?: boolean | null;
2749
+ ssl?: "off" | "flexible" | "full" | "strict" | "origin_pull" | null;
2750
+ sxg?: boolean | null;
2751
+ } | null;
2752
+ categories?: string[] | null;
2753
+ description?: string | null;
2754
+ enabled?: boolean | null;
2755
+ exposedCredentialCheck?: {
2756
+ passwordExpression: string;
2757
+ usernameExpression: string;
2758
+ } | null;
2759
+ expression?: string | null;
2760
+ logging?: {
2761
+ enabled: boolean;
2762
+ } | null;
2763
+ ratelimit?: {
2764
+ characteristics: string[];
2765
+ period: number;
2766
+ countingExpression?: string | null;
2767
+ mitigationTimeout?: number | null;
2768
+ requestsPerPeriod?: number | null;
2769
+ requestsToOrigin?: boolean | null;
2770
+ scorePerPeriod?: number | null;
2771
+ scoreResponseHeaderName?: string | null;
2772
+ } | null;
2773
+ ref?: string | null;
2774
+ } | {
2775
+ accountId?: string | null;
2776
+ zoneId?: string | null;
2777
+ id?: string | null;
2778
+ action?: "skip" | null;
2779
+ actionParameters?: {
2780
+ phase?: "current" | null;
2781
+ phases?: ("ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit")[] | null;
2782
+ products?: ("bic" | "hot" | "rateLimit" | "securityLevel" | "uaBlock" | "waf" | "zoneLockdown")[] | null;
2783
+ rules?: Record<string, unknown> | null;
2784
+ ruleset?: "current" | null;
2785
+ rulesets?: string[] | null;
2786
+ } | null;
2787
+ description?: string | null;
2788
+ enabled?: boolean | null;
2789
+ exposedCredentialCheck?: {
2790
+ passwordExpression: string;
2791
+ usernameExpression: string;
2792
+ } | null;
2793
+ expression?: string | null;
2794
+ logging?: {
2795
+ enabled: boolean;
2796
+ } | null;
2797
+ position?: {
2798
+ before?: string | null;
2799
+ } | {
2800
+ after?: string | null;
2801
+ } | {
2802
+ index?: number | null;
2803
+ } | null;
2804
+ ratelimit?: {
2805
+ characteristics: string[];
2806
+ period: number;
2807
+ countingExpression?: string | null;
2808
+ mitigationTimeout?: number | null;
2809
+ requestsPerPeriod?: number | null;
2810
+ requestsToOrigin?: boolean | null;
2811
+ scorePerPeriod?: number | null;
2812
+ scoreResponseHeaderName?: string | null;
2813
+ } | null;
2814
+ ref?: string | null;
2815
+ })[];
2816
+ /** The version of the ruleset. */
2817
+ version: string;
2818
+ /** An informative description of the ruleset. */
2819
+ description?: string | null;
2820
+ }
2821
+ export declare const DeleteRuleResponse: Schema.Schema<DeleteRuleResponse>;
2822
+ export type DeleteRuleError = DefaultErrors;
2823
+ export declare const deleteRule: API.OperationMethod<DeleteRuleRequest, DeleteRuleResponse, DeleteRuleError, Credentials | HttpClient.HttpClient>;
2824
+ export interface GetRulesetRequest {
2825
+ rulesetId: string;
2826
+ }
2827
+ export declare const GetRulesetRequest: Schema.Schema<GetRulesetRequest>;
2828
+ export interface GetRulesetResponse {
2829
+ /** The unique ID of the ruleset. */
2830
+ id: string;
2831
+ /** The kind of the ruleset. */
2832
+ kind: "zone" | "managed" | "custom" | "root";
2833
+ /** The timestamp of when the ruleset was last modified. */
2834
+ lastUpdated: string;
2835
+ /** The human-readable name of the ruleset. */
2836
+ name: string;
2837
+ /** The phase of the ruleset. */
2838
+ phase: "ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit";
2839
+ /** The list of rules in the ruleset. */
2840
+ rules: (unknown | {
2841
+ lastUpdated: string;
2842
+ version: string;
2843
+ id?: string | null;
2844
+ action?: "challenge" | null;
2845
+ actionParameters?: unknown | null;
2846
+ categories?: string[] | null;
2847
+ description?: string | null;
2848
+ enabled?: boolean | null;
2849
+ exposedCredentialCheck?: {
2850
+ passwordExpression: string;
2851
+ usernameExpression: string;
2852
+ } | null;
2853
+ expression?: string | null;
2854
+ logging?: unknown | null;
2855
+ ratelimit?: {
2856
+ characteristics: string[];
2857
+ period: number;
2858
+ countingExpression?: string | null;
2859
+ mitigationTimeout?: number | null;
2860
+ requestsPerPeriod?: number | null;
2861
+ requestsToOrigin?: boolean | null;
2862
+ scorePerPeriod?: number | null;
2863
+ scoreResponseHeaderName?: string | null;
2864
+ } | null;
2865
+ ref?: string | null;
2866
+ } | {
2867
+ lastUpdated: string;
2868
+ version: string;
2869
+ id?: string | null;
2870
+ action?: "js_challenge" | null;
2871
+ actionParameters?: unknown | null;
2872
+ categories?: string[] | null;
2873
+ description?: string | null;
2874
+ enabled?: boolean | null;
2875
+ exposedCredentialCheck?: {
2876
+ passwordExpression: string;
2877
+ usernameExpression: string;
2878
+ } | null;
2879
+ expression?: string | null;
2880
+ logging?: unknown | null;
2881
+ ratelimit?: {
2882
+ characteristics: string[];
2883
+ period: number;
2884
+ countingExpression?: string | null;
2885
+ mitigationTimeout?: number | null;
2886
+ requestsPerPeriod?: number | null;
2887
+ requestsToOrigin?: boolean | null;
2888
+ scorePerPeriod?: number | null;
2889
+ scoreResponseHeaderName?: string | null;
2890
+ } | null;
2891
+ ref?: string | null;
2892
+ })[];
2893
+ /** The version of the ruleset. */
2894
+ version: string;
2895
+ /** An informative description of the ruleset. */
2896
+ description?: string | null;
2897
+ }
2898
+ export declare const GetRulesetResponse: Schema.Schema<GetRulesetResponse>;
2899
+ export type GetRulesetError = DefaultErrors;
2900
+ export declare const getRuleset: API.OperationMethod<GetRulesetRequest, GetRulesetResponse, GetRulesetError, Credentials | HttpClient.HttpClient>;
2901
+ export interface ListRulesetsRequest {
2902
+ }
2903
+ export declare const ListRulesetsRequest: Schema.Schema<ListRulesetsRequest>;
2904
+ export type ListRulesetsResponse = {
2905
+ id: string;
2906
+ kind: "zone" | "managed" | "custom" | "root";
2907
+ lastUpdated: string;
2908
+ name: string;
2909
+ phase: "ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit";
2910
+ version: string;
2911
+ description?: string | null;
2912
+ }[];
2913
+ export declare const ListRulesetsResponse: Schema.Schema<ListRulesetsResponse>;
2914
+ export type ListRulesetsError = DefaultErrors;
2915
+ export declare const listRulesets: API.OperationMethod<ListRulesetsRequest, ListRulesetsResponse, ListRulesetsError, Credentials | HttpClient.HttpClient>;
2916
+ export interface CreateRulesetRequest {
2917
+ /** Path param: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. */
2918
+ accountId?: string;
2919
+ /** Path param: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. */
2920
+ zoneId?: string;
2921
+ /** Body param: The kind of the ruleset. */
2922
+ kind: "zone" | "managed" | "custom" | "root";
2923
+ /** Body param: The human-readable name of the ruleset. */
2924
+ name: string;
2925
+ /** Body param: The phase of the ruleset. */
2926
+ phase: "ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit";
2927
+ /** Body param: An informative description of the ruleset. */
2928
+ description?: string;
2929
+ /** Body param: The list of rules in the ruleset. */
2930
+ rules?: (unknown | {
2931
+ id?: string;
2932
+ action?: "challenge";
2933
+ actionParameters?: unknown;
2934
+ description?: string;
2935
+ enabled?: boolean;
2936
+ exposedCredentialCheck?: {
2937
+ passwordExpression: string;
2938
+ usernameExpression: string;
2939
+ };
2940
+ expression?: string;
2941
+ logging?: unknown;
2942
+ ratelimit?: {
2943
+ characteristics: string[];
2944
+ period: number;
2945
+ countingExpression?: string;
2946
+ mitigationTimeout?: number;
2947
+ requestsPerPeriod?: number;
2948
+ requestsToOrigin?: boolean;
2949
+ scorePerPeriod?: number;
2950
+ scoreResponseHeaderName?: string;
2951
+ };
2952
+ ref?: string;
2953
+ } | {
2954
+ id?: string;
2955
+ action?: "js_challenge";
2956
+ actionParameters?: unknown;
2957
+ description?: string;
2958
+ enabled?: boolean;
2959
+ exposedCredentialCheck?: {
2960
+ passwordExpression: string;
2961
+ usernameExpression: string;
2962
+ };
2963
+ expression?: string;
2964
+ logging?: unknown;
2965
+ ratelimit?: {
2966
+ characteristics: string[];
2967
+ period: number;
2968
+ countingExpression?: string;
2969
+ mitigationTimeout?: number;
2970
+ requestsPerPeriod?: number;
2971
+ requestsToOrigin?: boolean;
2972
+ scorePerPeriod?: number;
2973
+ scoreResponseHeaderName?: string;
2974
+ };
2975
+ ref?: string;
2976
+ })[];
2977
+ }
2978
+ export declare const CreateRulesetRequest: Schema.Schema<CreateRulesetRequest>;
2979
+ export interface CreateRulesetResponse {
2980
+ /** The unique ID of the ruleset. */
2981
+ id: string;
2982
+ /** The kind of the ruleset. */
2983
+ kind: "zone" | "managed" | "custom" | "root";
2984
+ /** The timestamp of when the ruleset was last modified. */
2985
+ lastUpdated: string;
2986
+ /** The human-readable name of the ruleset. */
2987
+ name: string;
2988
+ /** The phase of the ruleset. */
2989
+ phase: "ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit";
2990
+ /** The list of rules in the ruleset. */
2991
+ rules: (unknown | {
2992
+ lastUpdated: string;
2993
+ version: string;
2994
+ id?: string | null;
2995
+ action?: "challenge" | null;
2996
+ actionParameters?: unknown | null;
2997
+ categories?: string[] | null;
2998
+ description?: string | null;
2999
+ enabled?: boolean | null;
3000
+ exposedCredentialCheck?: {
3001
+ passwordExpression: string;
3002
+ usernameExpression: string;
3003
+ } | null;
3004
+ expression?: string | null;
3005
+ logging?: unknown | null;
3006
+ ratelimit?: {
3007
+ characteristics: string[];
3008
+ period: number;
3009
+ countingExpression?: string | null;
3010
+ mitigationTimeout?: number | null;
3011
+ requestsPerPeriod?: number | null;
3012
+ requestsToOrigin?: boolean | null;
3013
+ scorePerPeriod?: number | null;
3014
+ scoreResponseHeaderName?: string | null;
3015
+ } | null;
3016
+ ref?: string | null;
3017
+ } | {
3018
+ lastUpdated: string;
3019
+ version: string;
3020
+ id?: string | null;
3021
+ action?: "js_challenge" | null;
3022
+ actionParameters?: unknown | null;
3023
+ categories?: string[] | null;
3024
+ description?: string | null;
3025
+ enabled?: boolean | null;
3026
+ exposedCredentialCheck?: {
3027
+ passwordExpression: string;
3028
+ usernameExpression: string;
3029
+ } | null;
3030
+ expression?: string | null;
3031
+ logging?: unknown | null;
3032
+ ratelimit?: {
3033
+ characteristics: string[];
3034
+ period: number;
3035
+ countingExpression?: string | null;
3036
+ mitigationTimeout?: number | null;
3037
+ requestsPerPeriod?: number | null;
3038
+ requestsToOrigin?: boolean | null;
3039
+ scorePerPeriod?: number | null;
3040
+ scoreResponseHeaderName?: string | null;
3041
+ } | null;
3042
+ ref?: string | null;
3043
+ })[];
3044
+ /** The version of the ruleset. */
3045
+ version: string;
3046
+ /** An informative description of the ruleset. */
3047
+ description?: string | null;
3048
+ }
3049
+ export declare const CreateRulesetResponse: Schema.Schema<CreateRulesetResponse>;
3050
+ export type CreateRulesetError = DefaultErrors;
3051
+ export declare const createRuleset: API.OperationMethod<CreateRulesetRequest, CreateRulesetResponse, CreateRulesetError, Credentials | HttpClient.HttpClient>;
3052
+ export interface UpdateRulesetRequest {
3053
+ rulesetId: string;
3054
+ /** Path param: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. */
3055
+ accountId?: string;
3056
+ /** Path param: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. */
3057
+ zoneId?: string;
3058
+ /** Body param: An informative description of the ruleset. */
3059
+ description?: string;
3060
+ /** Body param: The kind of the ruleset. */
3061
+ kind?: "zone" | "managed" | "custom" | "root";
3062
+ /** Body param: The human-readable name of the ruleset. */
3063
+ name?: string;
3064
+ /** Body param: The phase of the ruleset. */
3065
+ phase?: "ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit";
3066
+ /** Body param: The list of rules in the ruleset. */
3067
+ rules?: (unknown | {
3068
+ id?: string;
3069
+ action?: "challenge";
3070
+ actionParameters?: unknown;
3071
+ description?: string;
3072
+ enabled?: boolean;
3073
+ exposedCredentialCheck?: {
3074
+ passwordExpression: string;
3075
+ usernameExpression: string;
3076
+ };
3077
+ expression?: string;
3078
+ logging?: unknown;
3079
+ ratelimit?: {
3080
+ characteristics: string[];
3081
+ period: number;
3082
+ countingExpression?: string;
3083
+ mitigationTimeout?: number;
3084
+ requestsPerPeriod?: number;
3085
+ requestsToOrigin?: boolean;
3086
+ scorePerPeriod?: number;
3087
+ scoreResponseHeaderName?: string;
3088
+ };
3089
+ ref?: string;
3090
+ } | {
3091
+ id?: string;
3092
+ action?: "js_challenge";
3093
+ actionParameters?: unknown;
3094
+ description?: string;
3095
+ enabled?: boolean;
3096
+ exposedCredentialCheck?: {
3097
+ passwordExpression: string;
3098
+ usernameExpression: string;
3099
+ };
3100
+ expression?: string;
3101
+ logging?: unknown;
3102
+ ratelimit?: {
3103
+ characteristics: string[];
3104
+ period: number;
3105
+ countingExpression?: string;
3106
+ mitigationTimeout?: number;
3107
+ requestsPerPeriod?: number;
3108
+ requestsToOrigin?: boolean;
3109
+ scorePerPeriod?: number;
3110
+ scoreResponseHeaderName?: string;
3111
+ };
3112
+ ref?: string;
3113
+ })[];
3114
+ }
3115
+ export declare const UpdateRulesetRequest: Schema.Schema<UpdateRulesetRequest>;
3116
+ export interface UpdateRulesetResponse {
3117
+ /** The unique ID of the ruleset. */
3118
+ id: string;
3119
+ /** The kind of the ruleset. */
3120
+ kind: "zone" | "managed" | "custom" | "root";
3121
+ /** The timestamp of when the ruleset was last modified. */
3122
+ lastUpdated: string;
3123
+ /** The human-readable name of the ruleset. */
3124
+ name: string;
3125
+ /** The phase of the ruleset. */
3126
+ phase: "ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit";
3127
+ /** The list of rules in the ruleset. */
3128
+ rules: (unknown | {
3129
+ lastUpdated: string;
3130
+ version: string;
3131
+ id?: string | null;
3132
+ action?: "challenge" | null;
3133
+ actionParameters?: unknown | null;
3134
+ categories?: string[] | null;
3135
+ description?: string | null;
3136
+ enabled?: boolean | null;
3137
+ exposedCredentialCheck?: {
3138
+ passwordExpression: string;
3139
+ usernameExpression: string;
3140
+ } | null;
3141
+ expression?: string | null;
3142
+ logging?: unknown | null;
3143
+ ratelimit?: {
3144
+ characteristics: string[];
3145
+ period: number;
3146
+ countingExpression?: string | null;
3147
+ mitigationTimeout?: number | null;
3148
+ requestsPerPeriod?: number | null;
3149
+ requestsToOrigin?: boolean | null;
3150
+ scorePerPeriod?: number | null;
3151
+ scoreResponseHeaderName?: string | null;
3152
+ } | null;
3153
+ ref?: string | null;
3154
+ } | {
3155
+ lastUpdated: string;
3156
+ version: string;
3157
+ id?: string | null;
3158
+ action?: "js_challenge" | null;
3159
+ actionParameters?: unknown | null;
3160
+ categories?: string[] | null;
3161
+ description?: string | null;
3162
+ enabled?: boolean | null;
3163
+ exposedCredentialCheck?: {
3164
+ passwordExpression: string;
3165
+ usernameExpression: string;
3166
+ } | null;
3167
+ expression?: string | null;
3168
+ logging?: unknown | null;
3169
+ ratelimit?: {
3170
+ characteristics: string[];
3171
+ period: number;
3172
+ countingExpression?: string | null;
3173
+ mitigationTimeout?: number | null;
3174
+ requestsPerPeriod?: number | null;
3175
+ requestsToOrigin?: boolean | null;
3176
+ scorePerPeriod?: number | null;
3177
+ scoreResponseHeaderName?: string | null;
3178
+ } | null;
3179
+ ref?: string | null;
3180
+ })[];
3181
+ /** The version of the ruleset. */
3182
+ version: string;
3183
+ /** An informative description of the ruleset. */
3184
+ description?: string | null;
3185
+ }
3186
+ export declare const UpdateRulesetResponse: Schema.Schema<UpdateRulesetResponse>;
3187
+ export type UpdateRulesetError = DefaultErrors;
3188
+ export declare const updateRuleset: API.OperationMethod<UpdateRulesetRequest, UpdateRulesetResponse, UpdateRulesetError, Credentials | HttpClient.HttpClient>;
3189
+ export interface DeleteRulesetRequest {
3190
+ rulesetId: string;
3191
+ }
3192
+ export declare const DeleteRulesetRequest: Schema.Schema<DeleteRulesetRequest>;
3193
+ export type DeleteRulesetResponse = unknown;
3194
+ export declare const DeleteRulesetResponse: Schema.Schema<unknown>;
3195
+ export type DeleteRulesetError = DefaultErrors;
3196
+ export declare const deleteRuleset: API.OperationMethod<DeleteRulesetRequest, DeleteRulesetResponse, DeleteRulesetError, Credentials | HttpClient.HttpClient>;
3197
+ export interface GetVersionRequest {
3198
+ rulesetId: string;
3199
+ rulesetVersion: string;
3200
+ }
3201
+ export declare const GetVersionRequest: Schema.Schema<GetVersionRequest>;
3202
+ export interface GetVersionResponse {
3203
+ /** The unique ID of the ruleset. */
3204
+ id: string;
3205
+ /** The kind of the ruleset. */
3206
+ kind: "zone" | "managed" | "custom" | "root";
3207
+ /** The timestamp of when the ruleset was last modified. */
3208
+ lastUpdated: string;
3209
+ /** The human-readable name of the ruleset. */
3210
+ name: string;
3211
+ /** The phase of the ruleset. */
3212
+ phase: "ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit";
3213
+ /** The list of rules in the ruleset. */
3214
+ rules: (unknown | {
3215
+ lastUpdated: string;
3216
+ version: string;
3217
+ id?: string | null;
3218
+ action?: "challenge" | null;
3219
+ actionParameters?: unknown | null;
3220
+ categories?: string[] | null;
3221
+ description?: string | null;
3222
+ enabled?: boolean | null;
3223
+ exposedCredentialCheck?: {
3224
+ passwordExpression: string;
3225
+ usernameExpression: string;
3226
+ } | null;
3227
+ expression?: string | null;
3228
+ logging?: unknown | null;
3229
+ ratelimit?: {
3230
+ characteristics: string[];
3231
+ period: number;
3232
+ countingExpression?: string | null;
3233
+ mitigationTimeout?: number | null;
3234
+ requestsPerPeriod?: number | null;
3235
+ requestsToOrigin?: boolean | null;
3236
+ scorePerPeriod?: number | null;
3237
+ scoreResponseHeaderName?: string | null;
3238
+ } | null;
3239
+ ref?: string | null;
3240
+ } | {
3241
+ lastUpdated: string;
3242
+ version: string;
3243
+ id?: string | null;
3244
+ action?: "js_challenge" | null;
3245
+ actionParameters?: unknown | null;
3246
+ categories?: string[] | null;
3247
+ description?: string | null;
3248
+ enabled?: boolean | null;
3249
+ exposedCredentialCheck?: {
3250
+ passwordExpression: string;
3251
+ usernameExpression: string;
3252
+ } | null;
3253
+ expression?: string | null;
3254
+ logging?: unknown | null;
3255
+ ratelimit?: {
3256
+ characteristics: string[];
3257
+ period: number;
3258
+ countingExpression?: string | null;
3259
+ mitigationTimeout?: number | null;
3260
+ requestsPerPeriod?: number | null;
3261
+ requestsToOrigin?: boolean | null;
3262
+ scorePerPeriod?: number | null;
3263
+ scoreResponseHeaderName?: string | null;
3264
+ } | null;
3265
+ ref?: string | null;
3266
+ })[];
3267
+ /** The version of the ruleset. */
3268
+ version: string;
3269
+ /** An informative description of the ruleset. */
3270
+ description?: string | null;
3271
+ }
3272
+ export declare const GetVersionResponse: Schema.Schema<GetVersionResponse>;
3273
+ export type GetVersionError = DefaultErrors;
3274
+ export declare const getVersion: API.OperationMethod<GetVersionRequest, GetVersionResponse, GetVersionError, Credentials | HttpClient.HttpClient>;
3275
+ export interface ListVersionsRequest {
3276
+ rulesetId: string;
3277
+ }
3278
+ export declare const ListVersionsRequest: Schema.Schema<ListVersionsRequest>;
3279
+ export type ListVersionsResponse = {
3280
+ id: string;
3281
+ kind: "zone" | "managed" | "custom" | "root";
3282
+ lastUpdated: string;
3283
+ name: string;
3284
+ phase: "ddos_l4" | "ddos_l7" | "http_config_settings" | "http_custom_errors" | "http_log_custom_fields" | "http_ratelimit" | "http_request_cache_settings" | "http_request_dynamic_redirect" | "http_request_firewall_custom" | "http_request_firewall_managed" | "http_request_late_transform" | "http_request_origin" | "http_request_redirect" | "http_request_sanitize" | "http_request_sbfm" | "http_request_transform" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit";
3285
+ version: string;
3286
+ description?: string | null;
3287
+ }[];
3288
+ export declare const ListVersionsResponse: Schema.Schema<ListVersionsResponse>;
3289
+ export type ListVersionsError = DefaultErrors;
3290
+ export declare const listVersions: API.OperationMethod<ListVersionsRequest, ListVersionsResponse, ListVersionsError, Credentials | HttpClient.HttpClient>;
3291
+ export interface DeleteVersionRequest {
3292
+ rulesetId: string;
3293
+ rulesetVersion: string;
3294
+ }
3295
+ export declare const DeleteVersionRequest: Schema.Schema<DeleteVersionRequest>;
3296
+ export type DeleteVersionResponse = unknown;
3297
+ export declare const DeleteVersionResponse: Schema.Schema<unknown>;
3298
+ export type DeleteVersionError = DefaultErrors;
3299
+ export declare const deleteVersion: API.OperationMethod<DeleteVersionRequest, DeleteVersionResponse, DeleteVersionError, Credentials | HttpClient.HttpClient>;
3300
+ //# sourceMappingURL=rulesets.d.ts.map