@distilled.cloud/cloudflare 0.0.0-john

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