gcore 0.12.0__py3-none-any.whl → 0.14.0__py3-none-any.whl

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.

Potentially problematic release.


This version of gcore might be problematic. Click here for more details.

Files changed (340) hide show
  1. gcore/__init__.py +3 -1
  2. gcore/_base_client.py +9 -9
  3. gcore/_client.py +25 -10
  4. gcore/_models.py +10 -4
  5. gcore/_qs.py +7 -7
  6. gcore/_types.py +18 -11
  7. gcore/_utils/_transform.py +2 -2
  8. gcore/_utils/_utils.py +4 -4
  9. gcore/_version.py +1 -1
  10. gcore/pagination.py +137 -0
  11. gcore/resources/__init__.py +14 -0
  12. gcore/resources/cdn/__init__.py +201 -0
  13. gcore/resources/cdn/audit_log.py +406 -0
  14. gcore/resources/cdn/cdn.py +957 -0
  15. gcore/resources/cdn/certificates.py +1062 -0
  16. gcore/resources/cdn/ip_ranges.py +224 -0
  17. gcore/resources/cdn/logs/__init__.py +33 -0
  18. gcore/resources/cdn/logs/logs.py +1424 -0
  19. gcore/resources/cdn/logs/settings.py +1081 -0
  20. gcore/resources/cdn/logs_uploader/__init__.py +61 -0
  21. gcore/resources/cdn/logs_uploader/configs.py +868 -0
  22. gcore/resources/cdn/logs_uploader/logs_uploader.py +166 -0
  23. gcore/resources/cdn/logs_uploader/policies.py +1060 -0
  24. gcore/resources/cdn/logs_uploader/targets.py +811 -0
  25. gcore/resources/cdn/metrics.py +419 -0
  26. gcore/resources/cdn/network_capacity.py +139 -0
  27. gcore/resources/cdn/origin_groups.py +1496 -0
  28. gcore/resources/cdn/resources/__init__.py +47 -0
  29. gcore/resources/cdn/resources/resources.py +2060 -0
  30. gcore/resources/cdn/resources/rules.py +1027 -0
  31. gcore/resources/cdn/resources/shield.py +259 -0
  32. gcore/resources/cdn/rule_templates.py +883 -0
  33. gcore/resources/cdn/shields.py +139 -0
  34. gcore/resources/cdn/statistics.py +1408 -0
  35. gcore/resources/cdn/trusted_ca_certificates.py +592 -0
  36. gcore/resources/cloud/audit_logs.py +33 -29
  37. gcore/resources/cloud/baremetal/flavors.py +21 -17
  38. gcore/resources/cloud/baremetal/images.py +19 -15
  39. gcore/resources/cloud/baremetal/servers.py +141 -119
  40. gcore/resources/cloud/billing_reservations.py +41 -33
  41. gcore/resources/cloud/cloud.py +24 -0
  42. gcore/resources/cloud/cost_reports.py +149 -119
  43. gcore/resources/cloud/file_shares/access_rules.py +25 -13
  44. gcore/resources/cloud/file_shares/file_shares.py +107 -71
  45. gcore/resources/cloud/floating_ips.py +270 -52
  46. gcore/resources/cloud/gpu_baremetal_clusters/flavors.py +13 -9
  47. gcore/resources/cloud/gpu_baremetal_clusters/gpu_baremetal_clusters.py +275 -65
  48. gcore/resources/cloud/gpu_baremetal_clusters/images.py +69 -53
  49. gcore/resources/cloud/gpu_baremetal_clusters/interfaces.py +9 -5
  50. gcore/resources/cloud/gpu_baremetal_clusters/servers.py +151 -127
  51. gcore/resources/cloud/inference/api_keys.py +51 -31
  52. gcore/resources/cloud/inference/applications/deployments.py +49 -31
  53. gcore/resources/cloud/inference/applications/templates.py +17 -9
  54. gcore/resources/cloud/inference/deployments/deployments.py +171 -139
  55. gcore/resources/cloud/inference/deployments/logs.py +17 -13
  56. gcore/resources/cloud/inference/flavors.py +21 -13
  57. gcore/resources/cloud/inference/inference.py +9 -5
  58. gcore/resources/cloud/inference/registry_credentials.py +45 -25
  59. gcore/resources/cloud/inference/secrets.py +45 -25
  60. gcore/resources/cloud/instances/flavors.py +17 -13
  61. gcore/resources/cloud/instances/images.py +153 -129
  62. gcore/resources/cloud/instances/instances.py +287 -213
  63. gcore/resources/cloud/instances/interfaces.py +165 -161
  64. gcore/resources/cloud/instances/metrics.py +9 -5
  65. gcore/resources/cloud/ip_ranges.py +25 -15
  66. gcore/resources/cloud/k8s/clusters/clusters.py +151 -87
  67. gcore/resources/cloud/k8s/clusters/nodes.py +19 -11
  68. gcore/resources/cloud/k8s/clusters/pools/nodes.py +19 -11
  69. gcore/resources/cloud/k8s/clusters/pools/pools.py +83 -59
  70. gcore/resources/cloud/k8s/flavors.py +13 -9
  71. gcore/resources/cloud/k8s/k8s.py +9 -5
  72. gcore/resources/cloud/load_balancers/flavors.py +11 -7
  73. gcore/resources/cloud/load_balancers/l7_policies/l7_policies.py +103 -83
  74. gcore/resources/cloud/load_balancers/l7_policies/rules.py +77 -57
  75. gcore/resources/cloud/load_balancers/listeners.py +125 -105
  76. gcore/resources/cloud/load_balancers/load_balancers.py +155 -123
  77. gcore/resources/cloud/load_balancers/metrics.py +9 -5
  78. gcore/resources/cloud/load_balancers/pools/health_monitors.py +25 -17
  79. gcore/resources/cloud/load_balancers/pools/members.py +31 -23
  80. gcore/resources/cloud/load_balancers/pools/pools.py +155 -129
  81. gcore/resources/cloud/load_balancers/statuses.py +17 -9
  82. gcore/resources/cloud/networks/networks.py +79 -55
  83. gcore/resources/cloud/networks/routers.py +75 -47
  84. gcore/resources/cloud/networks/subnets.py +105 -81
  85. gcore/resources/cloud/placement_groups.py +33 -17
  86. gcore/resources/cloud/projects.py +53 -41
  87. gcore/resources/cloud/quotas/quotas.py +25 -13
  88. gcore/resources/cloud/quotas/requests.py +41 -25
  89. gcore/resources/cloud/regions.py +25 -23
  90. gcore/resources/cloud/registries/artifacts.py +17 -9
  91. gcore/resources/cloud/registries/registries.py +55 -29
  92. gcore/resources/cloud/registries/repositories.py +17 -9
  93. gcore/resources/cloud/registries/tags.py +9 -5
  94. gcore/resources/cloud/registries/users.py +65 -35
  95. gcore/resources/cloud/reserved_fixed_ips/reserved_fixed_ips.py +123 -107
  96. gcore/resources/cloud/reserved_fixed_ips/vip.py +45 -25
  97. gcore/resources/cloud/secrets.py +43 -27
  98. gcore/resources/cloud/security_groups/rules.py +55 -43
  99. gcore/resources/cloud/security_groups/security_groups.py +79 -47
  100. gcore/resources/cloud/ssh_keys.py +51 -31
  101. gcore/resources/cloud/tasks.py +57 -45
  102. gcore/resources/cloud/usage_reports.py +27 -23
  103. gcore/resources/cloud/users/role_assignments.py +49 -33
  104. gcore/resources/cloud/volumes.py +237 -201
  105. gcore/resources/dns/dns.py +17 -13
  106. gcore/resources/dns/locations.py +29 -17
  107. gcore/resources/dns/metrics.py +13 -9
  108. gcore/resources/dns/pickers/pickers.py +5 -5
  109. gcore/resources/dns/pickers/presets.py +9 -5
  110. gcore/resources/dns/zones/dnssec.py +19 -11
  111. gcore/resources/dns/zones/rrsets.py +149 -91
  112. gcore/resources/dns/zones/zones.py +247 -189
  113. gcore/resources/fastedge/apps/apps.py +105 -89
  114. gcore/resources/fastedge/apps/logs.py +25 -21
  115. gcore/resources/fastedge/binaries.py +33 -17
  116. gcore/resources/fastedge/fastedge.py +5 -5
  117. gcore/resources/fastedge/kv_stores.py +43 -31
  118. gcore/resources/fastedge/secrets.py +69 -45
  119. gcore/resources/fastedge/statistics.py +25 -17
  120. gcore/resources/fastedge/templates.py +59 -39
  121. gcore/resources/iam/api_tokens.py +43 -27
  122. gcore/resources/iam/iam.py +5 -5
  123. gcore/resources/iam/users.py +97 -65
  124. gcore/resources/security/bgp_announces.py +27 -19
  125. gcore/resources/security/events.py +23 -19
  126. gcore/resources/security/profile_templates.py +9 -5
  127. gcore/resources/security/profiles.py +69 -45
  128. gcore/resources/storage/buckets/buckets.py +37 -25
  129. gcore/resources/storage/buckets/cors.py +19 -11
  130. gcore/resources/storage/buckets/lifecycle.py +19 -11
  131. gcore/resources/storage/buckets/policy.py +25 -13
  132. gcore/resources/storage/credentials.py +19 -15
  133. gcore/resources/storage/locations.py +13 -9
  134. gcore/resources/storage/statistics.py +39 -31
  135. gcore/resources/storage/storage.py +105 -69
  136. gcore/resources/streaming/ai_tasks.py +307 -197
  137. gcore/resources/streaming/broadcasts.py +63 -35
  138. gcore/resources/streaming/directories.py +65 -39
  139. gcore/resources/streaming/players.py +47 -31
  140. gcore/resources/streaming/playlists.py +189 -123
  141. gcore/resources/streaming/quality_sets.py +69 -39
  142. gcore/resources/streaming/restreams.py +47 -27
  143. gcore/resources/streaming/statistics.py +613 -407
  144. gcore/resources/streaming/streams/overlays.py +107 -67
  145. gcore/resources/streaming/streams/streams.py +403 -263
  146. gcore/resources/streaming/videos/subtitles.py +131 -75
  147. gcore/resources/streaming/videos/videos.py +429 -279
  148. gcore/resources/waap/advanced_rules.py +9 -5
  149. gcore/resources/waap/custom_page_sets.py +99 -75
  150. gcore/resources/waap/domains/advanced_rules.py +157 -99
  151. gcore/resources/waap/domains/api_discovery.py +71 -47
  152. gcore/resources/waap/domains/api_path_groups.py +9 -5
  153. gcore/resources/waap/domains/api_paths.py +79 -83
  154. gcore/resources/waap/domains/custom_rules.py +89 -59
  155. gcore/resources/waap/domains/domains.py +59 -41
  156. gcore/resources/waap/domains/firewall_rules.py +83 -55
  157. gcore/resources/waap/domains/insight_silences.py +59 -39
  158. gcore/resources/waap/domains/insights.py +39 -27
  159. gcore/resources/waap/domains/settings.py +21 -13
  160. gcore/resources/waap/domains/statistics.py +99 -75
  161. gcore/resources/waap/insights.py +23 -21
  162. gcore/resources/waap/ip_info/ip_info.py +70 -38
  163. gcore/resources/waap/ip_info/metrics.py +11 -7
  164. gcore/resources/waap/organizations.py +17 -13
  165. gcore/resources/waap/statistics.py +9 -5
  166. gcore/resources/waap/tags.py +17 -17
  167. gcore/resources/waap/waap.py +5 -5
  168. gcore/types/cdn/__init__.py +80 -0
  169. gcore/types/cdn/audit_log_list_params.py +73 -0
  170. gcore/types/cdn/ca_certificate.py +53 -0
  171. gcore/types/cdn/ca_certificate_list.py +10 -0
  172. gcore/types/cdn/cdn_account.py +86 -0
  173. gcore/types/cdn/cdn_account_limits.py +27 -0
  174. gcore/types/cdn/cdn_audit_log_entry.py +66 -0
  175. gcore/types/cdn/cdn_available_features.py +46 -0
  176. gcore/types/cdn/cdn_list_purge_statuses_params.py +67 -0
  177. gcore/types/cdn/cdn_log_entry.py +70 -0
  178. gcore/types/cdn/cdn_metrics.py +22 -0
  179. gcore/types/cdn/cdn_metrics_groups.py +13 -0
  180. gcore/types/cdn/cdn_metrics_values.py +19 -0
  181. gcore/types/cdn/cdn_resource.py +1977 -0
  182. gcore/types/cdn/cdn_resource_list.py +10 -0
  183. gcore/types/cdn/cdn_update_account_params.py +15 -0
  184. gcore/types/cdn/certificate_create_params.py +51 -0
  185. gcore/types/cdn/certificate_get_status_params.py +14 -0
  186. gcore/types/cdn/certificate_list_params.py +29 -0
  187. gcore/types/cdn/certificate_replace_params.py +39 -0
  188. gcore/types/cdn/log_download_params.py +279 -0
  189. gcore/types/cdn/log_list_params.py +273 -0
  190. gcore/types/cdn/logs/__init__.py +7 -0
  191. gcore/types/cdn/logs/log_settings.py +172 -0
  192. gcore/types/cdn/logs/setting_create_params.py +200 -0
  193. gcore/types/cdn/logs/setting_update_params.py +200 -0
  194. gcore/types/cdn/logs_aggregated_stats.py +23 -0
  195. gcore/types/cdn/logs_uploader/__init__.py +23 -0
  196. gcore/types/cdn/logs_uploader/config_create_params.py +32 -0
  197. gcore/types/cdn/logs_uploader/config_list_params.py +16 -0
  198. gcore/types/cdn/logs_uploader/config_replace_params.py +32 -0
  199. gcore/types/cdn/logs_uploader/config_update_params.py +32 -0
  200. gcore/types/cdn/logs_uploader/logs_uploader_config.py +51 -0
  201. gcore/types/cdn/logs_uploader/logs_uploader_config_list.py +10 -0
  202. gcore/types/cdn/logs_uploader/logs_uploader_policy.py +73 -0
  203. gcore/types/cdn/logs_uploader/logs_uploader_policy_list.py +10 -0
  204. gcore/types/cdn/logs_uploader/logs_uploader_target.py +236 -0
  205. gcore/types/cdn/logs_uploader/logs_uploader_target_list.py +10 -0
  206. gcore/types/cdn/logs_uploader/policy_create_params.py +61 -0
  207. gcore/types/cdn/logs_uploader/policy_list_fields_response.py +8 -0
  208. gcore/types/cdn/logs_uploader/policy_list_params.py +16 -0
  209. gcore/types/cdn/logs_uploader/policy_replace_params.py +61 -0
  210. gcore/types/cdn/logs_uploader/policy_update_params.py +61 -0
  211. gcore/types/cdn/logs_uploader/target_create_params.py +249 -0
  212. gcore/types/cdn/logs_uploader/target_list_params.py +16 -0
  213. gcore/types/cdn/logs_uploader/target_replace_params.py +249 -0
  214. gcore/types/cdn/logs_uploader/target_update_params.py +249 -0
  215. gcore/types/cdn/logs_uploader_validation.py +23 -0
  216. gcore/types/cdn/metric_list_params.py +168 -0
  217. gcore/types/cdn/network_capacity.py +22 -0
  218. gcore/types/cdn/origin_group_create_params.py +184 -0
  219. gcore/types/cdn/origin_group_list_params.py +24 -0
  220. gcore/types/cdn/origin_group_replace_params.py +190 -0
  221. gcore/types/cdn/origin_group_update_params.py +190 -0
  222. gcore/types/cdn/origin_groups.py +212 -0
  223. gcore/types/cdn/origin_groups_list.py +10 -0
  224. gcore/types/cdn/public_ip_list.py +15 -0
  225. gcore/types/cdn/public_network_list.py +15 -0
  226. gcore/types/cdn/purge_status.py +55 -0
  227. gcore/types/cdn/resource_aggregated_stats.py +80 -0
  228. gcore/types/cdn/resource_create_params.py +1825 -0
  229. gcore/types/cdn/resource_list_params.py +107 -0
  230. gcore/types/cdn/resource_prefetch_params.py +17 -0
  231. gcore/types/cdn/resource_purge_params.py +71 -0
  232. gcore/types/cdn/resource_replace_params.py +1803 -0
  233. gcore/types/cdn/resource_update_params.py +1794 -0
  234. gcore/types/cdn/resource_usage_stats.py +111 -0
  235. gcore/types/cdn/resources/__init__.py +11 -0
  236. gcore/types/cdn/resources/cdn_resource_rule.py +1695 -0
  237. gcore/types/cdn/resources/origin_shielding.py +15 -0
  238. gcore/types/cdn/resources/rule_create_params.py +1652 -0
  239. gcore/types/cdn/resources/rule_list_response.py +10 -0
  240. gcore/types/cdn/resources/rule_replace_params.py +1654 -0
  241. gcore/types/cdn/resources/rule_update_params.py +1654 -0
  242. gcore/types/cdn/resources/shield_replace_params.py +16 -0
  243. gcore/types/cdn/rule_template.py +1666 -0
  244. gcore/types/cdn/rule_template_create_params.py +1636 -0
  245. gcore/types/cdn/rule_template_list.py +10 -0
  246. gcore/types/cdn/rule_template_replace_params.py +1636 -0
  247. gcore/types/cdn/rule_template_update_params.py +1636 -0
  248. gcore/types/cdn/shield_aggregated_stats.py +23 -0
  249. gcore/types/cdn/shield_list_response.py +25 -0
  250. gcore/types/cdn/ssl_detail.py +62 -0
  251. gcore/types/cdn/ssl_detail_list.py +10 -0
  252. gcore/types/cdn/ssl_request_status.py +135 -0
  253. gcore/types/cdn/statistic_get_logs_usage_aggregated_params.py +42 -0
  254. gcore/types/cdn/statistic_get_logs_usage_series_params.py +35 -0
  255. gcore/types/cdn/statistic_get_resource_usage_aggregated_params.py +151 -0
  256. gcore/types/cdn/statistic_get_resource_usage_series_params.py +131 -0
  257. gcore/types/cdn/statistic_get_shield_usage_aggregated_params.py +42 -0
  258. gcore/types/cdn/statistic_get_shield_usage_series_params.py +25 -0
  259. gcore/types/cdn/trusted_ca_certificate_create_params.py +23 -0
  260. gcore/types/cdn/trusted_ca_certificate_list_params.py +29 -0
  261. gcore/types/cdn/trusted_ca_certificate_replace_params.py +15 -0
  262. gcore/types/cdn/usage_series_stats.py +31 -0
  263. gcore/types/cloud/__init__.py +2 -0
  264. gcore/types/cloud/file_share.py +4 -0
  265. gcore/types/cloud/file_share_create_params.py +20 -0
  266. gcore/types/cloud/file_share_update_params.py +40 -3
  267. gcore/types/cloud/floating_ip.py +1 -1
  268. gcore/types/cloud/floating_ip_detailed.py +1 -1
  269. gcore/types/cloud/floating_ip_update_params.py +43 -0
  270. gcore/types/cloud/gpu_baremetal_cluster_action_params.py +46 -0
  271. gcore/types/cloud/inference/inference_deployment.py +3 -1
  272. gcore/types/cloud/instance_create_params.py +3 -1
  273. gcore/types/cloud/k8s/cluster_create_params.py +46 -4
  274. gcore/types/cloud/k8s/cluster_update_params.py +60 -6
  275. gcore/types/cloud/k8s/clusters/pool_update_params.py +1 -1
  276. gcore/types/cloud/k8s/k8s_cluster.py +40 -3
  277. gcore/types/cloud/load_balancer_update_params.py +3 -1
  278. gcore/types/cloud/network_update_params.py +3 -1
  279. gcore/types/cloud/networks/subnet_update_params.py +3 -1
  280. gcore/types/cloud/registries/user_create_multiple_params.py +5 -3
  281. gcore/types/cloud/registries/user_create_params.py +5 -3
  282. gcore/types/cloud/registry_create_params.py +5 -3
  283. gcore/types/cloud/security_group_update_params.py +3 -1
  284. gcore/types/cloud/ssh_key_created.py +6 -3
  285. gcore/types/cloud/volume_update_params.py +3 -1
  286. gcore/types/dns/zone_get_statistics_params.py +12 -9
  287. gcore/types/dns/zone_get_statistics_response.py +3 -1
  288. gcore/types/dns/zone_import_params.py +21 -15
  289. gcore/types/dns/zones/dns_output_rrset.py +7 -3
  290. gcore/types/iam/account_overview.py +7 -2
  291. gcore/types/iam/user.py +7 -2
  292. gcore/types/iam/user_detailed.py +7 -2
  293. gcore/types/iam/user_invite_params.py +4 -1
  294. gcore/types/iam/user_update.py +7 -2
  295. gcore/types/iam/user_update_params.py +7 -2
  296. gcore/types/streaming/ai_contentmoderation_hardnudity.py +6 -4
  297. gcore/types/streaming/ai_contentmoderation_nsfw.py +6 -4
  298. gcore/types/streaming/ai_contentmoderation_softnudity.py +6 -4
  299. gcore/types/streaming/ai_contentmoderation_sport.py +6 -4
  300. gcore/types/streaming/ai_task.py +20 -11
  301. gcore/types/streaming/ai_task_create_params.py +20 -11
  302. gcore/types/streaming/ai_task_get_response.py +5 -4
  303. gcore/types/streaming/ai_task_list_params.py +11 -5
  304. gcore/types/streaming/clip.py +33 -22
  305. gcore/types/streaming/create_video_param.py +75 -43
  306. gcore/types/streaming/playlist.py +7 -5
  307. gcore/types/streaming/playlist_create_params.py +7 -5
  308. gcore/types/streaming/playlist_update_params.py +7 -5
  309. gcore/types/streaming/playlist_video.py +75 -43
  310. gcore/types/streaming/statistic_get_unique_viewers_cdn_params.py +7 -4
  311. gcore/types/streaming/stream.py +207 -136
  312. gcore/types/streaming/stream_create_clip_params.py +33 -22
  313. gcore/types/streaming/stream_create_params.py +41 -24
  314. gcore/types/streaming/stream_update_params.py +41 -24
  315. gcore/types/streaming/video.py +138 -76
  316. gcore/types/streaming/video_list_params.py +4 -2
  317. gcore/types/streaming/video_update_params.py +75 -43
  318. gcore/types/waap/__init__.py +2 -1
  319. gcore/types/waap/domain_update_params.py +2 -2
  320. gcore/types/waap/domains/advanced_rule_create_params.py +26 -18
  321. gcore/types/waap/domains/advanced_rule_list_params.py +10 -7
  322. gcore/types/waap/domains/advanced_rule_update_params.py +22 -17
  323. gcore/types/waap/domains/api_path_create_params.py +0 -3
  324. gcore/types/waap/domains/api_path_update_params.py +1 -3
  325. gcore/types/waap/domains/custom_rule_create_params.py +36 -35
  326. gcore/types/waap/domains/custom_rule_update_params.py +31 -33
  327. gcore/types/waap/domains/firewall_rule_create_params.py +6 -6
  328. gcore/types/waap/domains/firewall_rule_update_params.py +5 -5
  329. gcore/types/waap/domains/waap_advanced_rule.py +17 -9
  330. gcore/types/waap/domains/waap_custom_rule.py +5 -2
  331. gcore/types/waap/domains/waap_firewall_rule.py +1 -1
  332. gcore/types/waap/domains/waap_insight.py +1 -1
  333. gcore/types/waap/insight_list_types_params.py +1 -1
  334. gcore/types/waap/ip_info_get_top_urls_response.py +3 -12
  335. gcore/types/waap/{ip_info_get_ip_info_response.py → waap_ip_info.py} +2 -2
  336. gcore/types/waap/waap_top_url.py +13 -0
  337. {gcore-0.12.0.dist-info → gcore-0.14.0.dist-info}/METADATA +1 -1
  338. {gcore-0.12.0.dist-info → gcore-0.14.0.dist-info}/RECORD +340 -218
  339. {gcore-0.12.0.dist-info → gcore-0.14.0.dist-info}/WHEEL +0 -0
  340. {gcore-0.12.0.dist-info → gcore-0.14.0.dist-info}/licenses/LICENSE +0 -0
@@ -0,0 +1,1794 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from __future__ import annotations
4
+
5
+ from typing import Dict, List, Iterable, Optional
6
+ from typing_extensions import Literal, Required, Annotated, TypedDict
7
+
8
+ from ..._types import SequenceNotStr
9
+ from ..._utils import PropertyInfo
10
+
11
+ __all__ = [
12
+ "ResourceUpdateParams",
13
+ "Options",
14
+ "OptionsAllowedHTTPMethods",
15
+ "OptionsBotProtection",
16
+ "OptionsBotProtectionBotChallenge",
17
+ "OptionsBrotliCompression",
18
+ "OptionsBrowserCacheSettings",
19
+ "OptionsCacheHTTPHeaders",
20
+ "OptionsCors",
21
+ "OptionsCountryACL",
22
+ "OptionsDisableCache",
23
+ "OptionsDisableProxyForceRanges",
24
+ "OptionsEdgeCacheSettings",
25
+ "OptionsFastedge",
26
+ "OptionsFastedgeOnRequestBody",
27
+ "OptionsFastedgeOnRequestHeaders",
28
+ "OptionsFastedgeOnResponseBody",
29
+ "OptionsFastedgeOnResponseHeaders",
30
+ "OptionsFetchCompressed",
31
+ "OptionsFollowOriginRedirect",
32
+ "OptionsForceReturn",
33
+ "OptionsForceReturnTimeInterval",
34
+ "OptionsForwardHostHeader",
35
+ "OptionsGzipOn",
36
+ "OptionsHostHeader",
37
+ "OptionsHttp3Enabled",
38
+ "OptionsIgnoreCookie",
39
+ "OptionsIgnoreQueryString",
40
+ "OptionsImageStack",
41
+ "OptionsIPAddressACL",
42
+ "OptionsLimitBandwidth",
43
+ "OptionsProxyCacheKey",
44
+ "OptionsProxyCacheMethodsSet",
45
+ "OptionsProxyConnectTimeout",
46
+ "OptionsProxyReadTimeout",
47
+ "OptionsQueryParamsBlacklist",
48
+ "OptionsQueryParamsWhitelist",
49
+ "OptionsQueryStringForwarding",
50
+ "OptionsRedirectHTTPToHTTPS",
51
+ "OptionsRedirectHTTPSToHTTP",
52
+ "OptionsReferrerACL",
53
+ "OptionsRequestLimiter",
54
+ "OptionsResponseHeadersHidingPolicy",
55
+ "OptionsRewrite",
56
+ "OptionsSecureKey",
57
+ "OptionsSlice",
58
+ "OptionsSni",
59
+ "OptionsStale",
60
+ "OptionsStaticResponseHeaders",
61
+ "OptionsStaticResponseHeadersValue",
62
+ "OptionsStaticHeaders",
63
+ "OptionsStaticRequestHeaders",
64
+ "OptionsTlsVersions",
65
+ "OptionsUseDefaultLeChain",
66
+ "OptionsUseDns01LeChallenge",
67
+ "OptionsUseRsaLeCert",
68
+ "OptionsUserAgentACL",
69
+ "OptionsWaap",
70
+ "OptionsWebsockets",
71
+ ]
72
+
73
+
74
+ class ResourceUpdateParams(TypedDict, total=False):
75
+ active: bool
76
+ """Enables or disables a CDN resource.
77
+
78
+ Possible values:
79
+
80
+ - **true** - CDN resource is active. Content is being delivered.
81
+ - **false** - CDN resource is deactivated. Content is not being delivered.
82
+ """
83
+
84
+ description: str
85
+ """Optional comment describing the CDN resource."""
86
+
87
+ name: Optional[str]
88
+ """CDN resource name."""
89
+
90
+ options: Options
91
+ """List of options that can be configured for the CDN resource.
92
+
93
+ In case of `null` value the option is not added to the CDN resource. Option may
94
+ inherit its value from the global account settings.
95
+ """
96
+
97
+ origin_group: Annotated[int, PropertyInfo(alias="originGroup")]
98
+ """Origin group ID with which the CDN resource is associated.
99
+
100
+ You can use either the `origin` or `originGroup` parameter in the request.
101
+ """
102
+
103
+ origin_protocol: Annotated[Literal["HTTP", "HTTPS", "MATCH"], PropertyInfo(alias="originProtocol")]
104
+ """Protocol used by CDN servers to request content from an origin source.
105
+
106
+ Possible values:
107
+
108
+ - **HTTPS** - CDN servers will connect to the origin via HTTPS.
109
+ - **HTTP** - CDN servers will connect to the origin via HTTP.
110
+ - **MATCH** - connection protocol will be chosen automatically (content on the
111
+ origin source should be available for the CDN both through HTTP and HTTPS).
112
+
113
+ If protocol is not specified, HTTP is used to connect to an origin server.
114
+ """
115
+
116
+ proxy_ssl_ca: Optional[int]
117
+ """ID of the trusted CA certificate used to verify an origin.
118
+
119
+ It can be used only with `"`proxy_ssl_enabled`": true`.
120
+ """
121
+
122
+ proxy_ssl_data: Optional[int]
123
+ """ID of the SSL certificate used to verify an origin.
124
+
125
+ It can be used only with `"`proxy_ssl_enabled`": true`.
126
+ """
127
+
128
+ proxy_ssl_enabled: bool
129
+ """
130
+ Enables or disables SSL certificate validation of the origin server before
131
+ completing any connection.
132
+
133
+ Possible values:
134
+
135
+ - **true** - Origin SSL certificate validation is enabled.
136
+ - **false** - Origin SSL certificate validation is disabled.
137
+ """
138
+
139
+ secondary_hostnames: Annotated[SequenceNotStr[str], PropertyInfo(alias="secondaryHostnames")]
140
+ """
141
+ Additional delivery domains (CNAMEs) that will be used to deliver content via
142
+ the CDN.
143
+
144
+ Up to ten additional CNAMEs are possible.
145
+ """
146
+
147
+ ssl_data: Annotated[Optional[int], PropertyInfo(alias="sslData")]
148
+ """ID of the SSL certificate linked to the CDN resource.
149
+
150
+ Can be used only with `"sslEnabled": true`.
151
+ """
152
+
153
+ ssl_enabled: Annotated[bool, PropertyInfo(alias="sslEnabled")]
154
+ """Defines whether the HTTPS protocol enabled for content delivery.
155
+
156
+ Possible values:
157
+
158
+ - **true** - HTTPS is enabled.
159
+ - **false** - HTTPS is disabled.
160
+ """
161
+
162
+
163
+ class OptionsAllowedHTTPMethods(TypedDict, total=False):
164
+ enabled: Required[bool]
165
+ """Controls the option state.
166
+
167
+ Possible values:
168
+
169
+ - **true** - Option is enabled.
170
+ - **false** - Option is disabled.
171
+ """
172
+
173
+ value: Required[List[Literal["GET", "HEAD", "POST", "PUT", "PATCH", "DELETE", "OPTIONS"]]]
174
+
175
+
176
+ class OptionsBotProtectionBotChallenge(TypedDict, total=False):
177
+ enabled: bool
178
+ """Possible values:
179
+
180
+ - **true** - Bot challenge is enabled.
181
+ - **false** - Bot challenge is disabled.
182
+ """
183
+
184
+
185
+ class OptionsBotProtection(TypedDict, total=False):
186
+ bot_challenge: Required[OptionsBotProtectionBotChallenge]
187
+ """Controls the bot challenge module state."""
188
+
189
+ enabled: Required[bool]
190
+ """Controls the option state.
191
+
192
+ Possible values:
193
+
194
+ - **true** - Option is enabled.
195
+ - **false** - Option is disabled.
196
+ """
197
+
198
+
199
+ class OptionsBrotliCompression(TypedDict, total=False):
200
+ enabled: Required[bool]
201
+ """Controls the option state.
202
+
203
+ Possible values:
204
+
205
+ - **true** - Option is enabled.
206
+ - **false** - Option is disabled.
207
+ """
208
+
209
+ value: Required[
210
+ List[
211
+ Literal[
212
+ "application/javascript",
213
+ "application/json",
214
+ "application/vnd.ms-fontobject",
215
+ "application/wasm",
216
+ "application/x-font-ttf",
217
+ "application/x-javascript",
218
+ "application/xml",
219
+ "application/xml+rss",
220
+ "image/svg+xml",
221
+ "image/x-icon",
222
+ "text/css",
223
+ "text/html",
224
+ "text/javascript",
225
+ "text/plain",
226
+ "text/xml",
227
+ ]
228
+ ]
229
+ ]
230
+ """Allows to select the content types you want to compress.
231
+
232
+ `text/html` is a mandatory content type.
233
+ """
234
+
235
+
236
+ class OptionsBrowserCacheSettings(TypedDict, total=False):
237
+ enabled: Required[bool]
238
+ """Controls the option state.
239
+
240
+ Possible values:
241
+
242
+ - **true** - Option is enabled.
243
+ - **false** - Option is disabled.
244
+ """
245
+
246
+ value: Required[str]
247
+ """Set the cache expiration time to '0s' to disable caching.
248
+
249
+ The maximum duration is any equivalent to `1y`.
250
+ """
251
+
252
+
253
+ class OptionsCacheHTTPHeaders(TypedDict, total=False):
254
+ enabled: Required[bool]
255
+ """Controls the option state.
256
+
257
+ Possible values:
258
+
259
+ - **true** - Option is enabled.
260
+ - **false** - Option is disabled.
261
+ """
262
+
263
+ value: Required[SequenceNotStr[str]]
264
+
265
+
266
+ class OptionsCors(TypedDict, total=False):
267
+ enabled: Required[bool]
268
+ """Controls the option state.
269
+
270
+ Possible values:
271
+
272
+ - **true** - Option is enabled.
273
+ - **false** - Option is disabled.
274
+ """
275
+
276
+ value: Required[SequenceNotStr[str]]
277
+ """Value of the Access-Control-Allow-Origin header.
278
+
279
+ Possible values:
280
+
281
+ - **Adds \\** as the Access-Control-Allow-Origin header value** - Content will be
282
+ uploaded for requests from any domain. `"value": ["\\**"]`
283
+ - **Adds "$`http_origin`" as the Access-Control-Allow-Origin header value if the
284
+ origin matches one of the listed domains** - Content will be uploaded only for
285
+ requests from the domains specified in the field.
286
+ `"value": ["domain.com", "second.dom.com"]`
287
+ - **Adds "$`http_origin`" as the Access-Control-Allow-Origin header value** -
288
+ Content will be uploaded for requests from any domain, and the domain from
289
+ which the request was sent will be added to the "Access-Control-Allow-Origin"
290
+ header in the response. `"value": ["$`http_origin`"]`
291
+ """
292
+
293
+ always: bool
294
+ """
295
+ Defines whether the Access-Control-Allow-Origin header should be added to a
296
+ response from CDN regardless of response code.
297
+
298
+ Possible values:
299
+
300
+ - **true** - Header will be added to a response regardless of response code.
301
+ - **false** - Header will only be added to responses with codes: 200, 201, 204,
302
+ 206, 301, 302, 303, 304, 307, 308.
303
+ """
304
+
305
+
306
+ class OptionsCountryACL(TypedDict, total=False):
307
+ enabled: Required[bool]
308
+ """Controls the option state.
309
+
310
+ Possible values:
311
+
312
+ - **true** - Option is enabled.
313
+ - **false** - Option is disabled.
314
+ """
315
+
316
+ excepted_values: Required[SequenceNotStr[str]]
317
+ """List of countries according to ISO-3166-1.
318
+
319
+ The meaning of the parameter depends on `policy_type` value:
320
+
321
+ - **allow** - List of countries for which access is prohibited.
322
+ - **deny** - List of countries for which access is allowed.
323
+ """
324
+
325
+ policy_type: Required[Literal["allow", "deny"]]
326
+ """Defines the type of CDN resource access policy.
327
+
328
+ Possible values:
329
+
330
+ - **allow** - Access is allowed for all the countries except for those specified
331
+ in `excepted_values` field.
332
+ - **deny** - Access is denied for all the countries except for those specified
333
+ in `excepted_values` field.
334
+ """
335
+
336
+
337
+ class OptionsDisableCache(TypedDict, total=False):
338
+ enabled: Required[bool]
339
+ """Controls the option state.
340
+
341
+ Possible values:
342
+
343
+ - **true** - Option is enabled.
344
+ - **false** - Option is disabled.
345
+ """
346
+
347
+ value: Required[bool]
348
+ """Possible values:
349
+
350
+ - **true** - content caching is disabled.
351
+ - **false** - content caching is enabled.
352
+ """
353
+
354
+
355
+ class OptionsDisableProxyForceRanges(TypedDict, total=False):
356
+ enabled: Required[bool]
357
+ """Controls the option state.
358
+
359
+ Possible values:
360
+
361
+ - **true** - Option is enabled.
362
+ - **false** - Option is disabled.
363
+ """
364
+
365
+ value: Required[bool]
366
+ """Possible values:
367
+
368
+ - **true** - Option is enabled.
369
+ - **false** - Option is disabled.
370
+ """
371
+
372
+
373
+ class OptionsEdgeCacheSettings(TypedDict, total=False):
374
+ enabled: Required[bool]
375
+ """Controls the option state.
376
+
377
+ Possible values:
378
+
379
+ - **true** - Option is enabled.
380
+ - **false** - Option is disabled.
381
+ """
382
+
383
+ custom_values: Dict[str, str]
384
+ """
385
+ A MAP object representing the caching time in seconds for a response with a
386
+ specific response code.
387
+
388
+ These settings have a higher priority than the `value` field.
389
+
390
+ - Use `any` key to specify caching time for all response codes.
391
+ - Use `0s` value to disable caching for a specific response code.
392
+ """
393
+
394
+ default: str
395
+ """Enables content caching according to the origin cache settings.
396
+
397
+ The value is applied to the following response codes 200, 201, 204, 206, 301,
398
+ 302, 303, 304, 307, 308, if an origin server does not have caching HTTP headers.
399
+
400
+ Responses with other codes will not be cached.
401
+
402
+ The maximum duration is any equivalent to `1y`.
403
+ """
404
+
405
+ value: str
406
+ """Caching time.
407
+
408
+ The value is applied to the following response codes: 200, 206, 301, 302.
409
+ Responses with codes 4xx, 5xx will not be cached.
410
+
411
+ Use `0s` to disable caching.
412
+
413
+ The maximum duration is any equivalent to `1y`.
414
+ """
415
+
416
+
417
+ class OptionsFastedgeOnRequestBody(TypedDict, total=False):
418
+ app_id: Required[str]
419
+ """The ID of the application in FastEdge."""
420
+
421
+ enabled: bool
422
+ """
423
+ Determines if the FastEdge application should be called whenever HTTP request
424
+ headers are received.
425
+ """
426
+
427
+ execute_on_edge: bool
428
+ """Determines if the request should be executed at the edge nodes."""
429
+
430
+ execute_on_shield: bool
431
+ """Determines if the request should be executed at the shield nodes."""
432
+
433
+ interrupt_on_error: bool
434
+ """Determines if the request execution should be interrupted when an error occurs."""
435
+
436
+
437
+ class OptionsFastedgeOnRequestHeaders(TypedDict, total=False):
438
+ app_id: Required[str]
439
+ """The ID of the application in FastEdge."""
440
+
441
+ enabled: bool
442
+ """
443
+ Determines if the FastEdge application should be called whenever HTTP request
444
+ headers are received.
445
+ """
446
+
447
+ execute_on_edge: bool
448
+ """Determines if the request should be executed at the edge nodes."""
449
+
450
+ execute_on_shield: bool
451
+ """Determines if the request should be executed at the shield nodes."""
452
+
453
+ interrupt_on_error: bool
454
+ """Determines if the request execution should be interrupted when an error occurs."""
455
+
456
+
457
+ class OptionsFastedgeOnResponseBody(TypedDict, total=False):
458
+ app_id: Required[str]
459
+ """The ID of the application in FastEdge."""
460
+
461
+ enabled: bool
462
+ """
463
+ Determines if the FastEdge application should be called whenever HTTP request
464
+ headers are received.
465
+ """
466
+
467
+ execute_on_edge: bool
468
+ """Determines if the request should be executed at the edge nodes."""
469
+
470
+ execute_on_shield: bool
471
+ """Determines if the request should be executed at the shield nodes."""
472
+
473
+ interrupt_on_error: bool
474
+ """Determines if the request execution should be interrupted when an error occurs."""
475
+
476
+
477
+ class OptionsFastedgeOnResponseHeaders(TypedDict, total=False):
478
+ app_id: Required[str]
479
+ """The ID of the application in FastEdge."""
480
+
481
+ enabled: bool
482
+ """
483
+ Determines if the FastEdge application should be called whenever HTTP request
484
+ headers are received.
485
+ """
486
+
487
+ execute_on_edge: bool
488
+ """Determines if the request should be executed at the edge nodes."""
489
+
490
+ execute_on_shield: bool
491
+ """Determines if the request should be executed at the shield nodes."""
492
+
493
+ interrupt_on_error: bool
494
+ """Determines if the request execution should be interrupted when an error occurs."""
495
+
496
+
497
+ class OptionsFastedge(TypedDict, total=False):
498
+ enabled: Required[bool]
499
+ """Controls the option state.
500
+
501
+ Possible values:
502
+
503
+ - **true** - Option is enabled.
504
+ - **false** - Option is disabled.
505
+ """
506
+
507
+ on_request_body: OptionsFastedgeOnRequestBody
508
+ """
509
+ Allows to configure FastEdge application that will be called to handle request
510
+ body as soon as CDN receives incoming HTTP request.
511
+ """
512
+
513
+ on_request_headers: OptionsFastedgeOnRequestHeaders
514
+ """
515
+ Allows to configure FastEdge application that will be called to handle request
516
+ headers as soon as CDN receives incoming HTTP request.
517
+ """
518
+
519
+ on_response_body: OptionsFastedgeOnResponseBody
520
+ """
521
+ Allows to configure FastEdge application that will be called to handle response
522
+ body before CDN sends the HTTP response.
523
+ """
524
+
525
+ on_response_headers: OptionsFastedgeOnResponseHeaders
526
+ """
527
+ Allows to configure FastEdge application that will be called to handle response
528
+ headers before CDN sends the HTTP response.
529
+ """
530
+
531
+
532
+ class OptionsFetchCompressed(TypedDict, total=False):
533
+ enabled: Required[bool]
534
+ """Controls the option state.
535
+
536
+ Possible values:
537
+
538
+ - **true** - Option is enabled.
539
+ - **false** - Option is disabled.
540
+ """
541
+
542
+ value: Required[bool]
543
+ """Possible values:
544
+
545
+ - **true** - Option is enabled.
546
+ - **false** - Option is disabled.
547
+ """
548
+
549
+
550
+ class OptionsFollowOriginRedirect(TypedDict, total=False):
551
+ codes: Required[Iterable[Literal[301, 302, 303, 307, 308]]]
552
+ """Redirect status code that the origin server returns.
553
+
554
+ To serve up to date content to end users, you will need to purge the cache after
555
+ managing the option.
556
+ """
557
+
558
+ enabled: Required[bool]
559
+ """Controls the option state.
560
+
561
+ Possible values:
562
+
563
+ - **true** - Option is enabled.
564
+ - **false** - Option is disabled.
565
+ """
566
+
567
+
568
+ class OptionsForceReturnTimeInterval(TypedDict, total=False):
569
+ end_time: Required[str]
570
+ """Time until which a custom HTTP response code should be applied.
571
+
572
+ Indicated in 24-hour format.
573
+ """
574
+
575
+ start_time: Required[str]
576
+ """Time from which a custom HTTP response code should be applied.
577
+
578
+ Indicated in 24-hour format.
579
+ """
580
+
581
+ time_zone: str
582
+ """Time zone used to calculate time."""
583
+
584
+
585
+ class OptionsForceReturn(TypedDict, total=False):
586
+ body: Required[str]
587
+ """URL for redirection or text."""
588
+
589
+ code: Required[int]
590
+ """Status code value."""
591
+
592
+ enabled: Required[bool]
593
+ """Controls the option state.
594
+
595
+ Possible values:
596
+
597
+ - **true** - Option is enabled.
598
+ - **false** - Option is disabled.
599
+ """
600
+
601
+ time_interval: Optional[OptionsForceReturnTimeInterval]
602
+ """Controls the time at which a custom HTTP response code should be applied.
603
+
604
+ By default, a custom HTTP response code is applied at any time.
605
+ """
606
+
607
+
608
+ class OptionsForwardHostHeader(TypedDict, total=False):
609
+ enabled: Required[bool]
610
+ """Controls the option state.
611
+
612
+ Possible values:
613
+
614
+ - **true** - Option is enabled.
615
+ - **false** - Option is disabled.
616
+ """
617
+
618
+ value: Required[bool]
619
+ """Possible values:
620
+
621
+ - **true** - Option is enabled.
622
+ - **false** - Option is disabled.
623
+ """
624
+
625
+
626
+ class OptionsGzipOn(TypedDict, total=False):
627
+ enabled: Required[bool]
628
+ """Controls the option state.
629
+
630
+ Possible values:
631
+
632
+ - **true** - Option is enabled.
633
+ - **false** - Option is disabled.
634
+ """
635
+
636
+ value: Required[bool]
637
+ """Possible values:
638
+
639
+ - **true** - Option is enabled.
640
+ - **false** - Option is disabled.
641
+ """
642
+
643
+
644
+ class OptionsHostHeader(TypedDict, total=False):
645
+ enabled: Required[bool]
646
+ """Controls the option state.
647
+
648
+ Possible values:
649
+
650
+ - **true** - Option is enabled.
651
+ - **false** - Option is disabled.
652
+ """
653
+
654
+ value: Required[str]
655
+ """Host Header value."""
656
+
657
+
658
+ class OptionsHttp3Enabled(TypedDict, total=False):
659
+ enabled: Required[bool]
660
+ """Controls the option state.
661
+
662
+ Possible values:
663
+
664
+ - **true** - Option is enabled.
665
+ - **false** - Option is disabled.
666
+ """
667
+
668
+ value: Required[bool]
669
+ """Possible values:
670
+
671
+ - **true** - Option is enabled.
672
+ - **false** - Option is disabled.
673
+ """
674
+
675
+
676
+ class OptionsIgnoreCookie(TypedDict, total=False):
677
+ enabled: Required[bool]
678
+ """Controls the option state.
679
+
680
+ Possible values:
681
+
682
+ - **true** - Option is enabled.
683
+ - **false** - Option is disabled.
684
+ """
685
+
686
+ value: Required[bool]
687
+ """Possible values:
688
+
689
+ - **true** - Option is enabled, files with cookies are cached as one file.
690
+ - **false** - Option is disabled, files with cookies are cached as different
691
+ files.
692
+ """
693
+
694
+
695
+ class OptionsIgnoreQueryString(TypedDict, total=False):
696
+ enabled: Required[bool]
697
+ """Controls the option state.
698
+
699
+ Possible values:
700
+
701
+ - **true** - Option is enabled.
702
+ - **false** - Option is disabled.
703
+ """
704
+
705
+ value: Required[bool]
706
+ """Possible values:
707
+
708
+ - **true** - Option is enabled.
709
+ - **false** - Option is disabled.
710
+ """
711
+
712
+
713
+ class OptionsImageStack(TypedDict, total=False):
714
+ enabled: Required[bool]
715
+ """Controls the option state.
716
+
717
+ Possible values:
718
+
719
+ - **true** - Option is enabled.
720
+ - **false** - Option is disabled.
721
+ """
722
+
723
+ avif_enabled: bool
724
+ """Enables or disables automatic conversion of JPEG and PNG images to AVI format."""
725
+
726
+ png_lossless: bool
727
+ """Enables or disables compression without quality loss for PNG format."""
728
+
729
+ quality: int
730
+ """Defines quality settings for JPG and PNG images.
731
+
732
+ The higher the value, the better the image quality, and the larger the file size
733
+ after conversion.
734
+ """
735
+
736
+ webp_enabled: bool
737
+ """Enables or disables automatic conversion of JPEG and PNG images to WebP format."""
738
+
739
+
740
+ class OptionsIPAddressACL(TypedDict, total=False):
741
+ enabled: Required[bool]
742
+ """Controls the option state.
743
+
744
+ Possible values:
745
+
746
+ - **true** - Option is enabled.
747
+ - **false** - Option is disabled.
748
+ """
749
+
750
+ excepted_values: Required[SequenceNotStr[str]]
751
+ """List of IP addresses with a subnet mask.
752
+
753
+ The meaning of the parameter depends on `policy_type` value:
754
+
755
+ - **allow** - List of IP addresses for which access is prohibited.
756
+ - **deny** - List of IP addresses for which access is allowed.
757
+
758
+ Examples:
759
+
760
+ - `192.168.3.2/32`
761
+ - `2a03:d000:2980:7::8/128`
762
+ """
763
+
764
+ policy_type: Required[Literal["allow", "deny"]]
765
+ """IP access policy type.
766
+
767
+ Possible values:
768
+
769
+ - **allow** - Allow access to all IPs except IPs specified in
770
+ "`excepted_values`" field.
771
+ - **deny** - Deny access to all IPs except IPs specified in "`excepted_values`"
772
+ field.
773
+ """
774
+
775
+
776
+ class OptionsLimitBandwidth(TypedDict, total=False):
777
+ enabled: Required[bool]
778
+ """Controls the option state.
779
+
780
+ Possible values:
781
+
782
+ - **true** - Option is enabled.
783
+ - **false** - Option is disabled.
784
+ """
785
+
786
+ limit_type: Required[Literal["static", "dynamic"]]
787
+ """Method of controlling the download speed per connection.
788
+
789
+ Possible values:
790
+
791
+ - **static** - Use speed and buffer fields to set the download speed limit.
792
+ - **dynamic** - Use query strings **speed** and **buffer** to set the download
793
+ speed limit.
794
+
795
+ For example, when requesting content at the link
796
+
797
+ ```
798
+ http://cdn.example.com/video.mp4?speed=50k&buffer=500k
799
+ ```
800
+
801
+ the download speed will be limited to 50kB/s after 500 kB.
802
+ """
803
+
804
+ buffer: int
805
+ """Amount of downloaded data after which the user will be rate limited."""
806
+
807
+ speed: int
808
+ """Maximum download speed per connection."""
809
+
810
+
811
+ class OptionsProxyCacheKey(TypedDict, total=False):
812
+ enabled: Required[bool]
813
+ """Controls the option state.
814
+
815
+ Possible values:
816
+
817
+ - **true** - Option is enabled.
818
+ - **false** - Option is disabled.
819
+ """
820
+
821
+ value: Required[str]
822
+ """Key for caching."""
823
+
824
+
825
+ class OptionsProxyCacheMethodsSet(TypedDict, total=False):
826
+ enabled: Required[bool]
827
+ """Controls the option state.
828
+
829
+ Possible values:
830
+
831
+ - **true** - Option is enabled.
832
+ - **false** - Option is disabled.
833
+ """
834
+
835
+ value: Required[bool]
836
+ """Possible values:
837
+
838
+ - **true** - Option is enabled.
839
+ - **false** - Option is disabled.
840
+ """
841
+
842
+
843
+ class OptionsProxyConnectTimeout(TypedDict, total=False):
844
+ enabled: Required[bool]
845
+ """Controls the option state.
846
+
847
+ Possible values:
848
+
849
+ - **true** - Option is enabled.
850
+ - **false** - Option is disabled.
851
+ """
852
+
853
+ value: Required[str]
854
+ """Timeout value in seconds."""
855
+
856
+
857
+ class OptionsProxyReadTimeout(TypedDict, total=False):
858
+ enabled: Required[bool]
859
+ """Controls the option state.
860
+
861
+ Possible values:
862
+
863
+ - **true** - Option is enabled.
864
+ - **false** - Option is disabled.
865
+ """
866
+
867
+ value: Required[str]
868
+ """Timeout value in seconds."""
869
+
870
+
871
+ class OptionsQueryParamsBlacklist(TypedDict, total=False):
872
+ enabled: Required[bool]
873
+ """Controls the option state.
874
+
875
+ Possible values:
876
+
877
+ - **true** - Option is enabled.
878
+ - **false** - Option is disabled.
879
+ """
880
+
881
+ value: Required[SequenceNotStr[str]]
882
+ """List of query parameters."""
883
+
884
+
885
+ class OptionsQueryParamsWhitelist(TypedDict, total=False):
886
+ enabled: Required[bool]
887
+ """Controls the option state.
888
+
889
+ Possible values:
890
+
891
+ - **true** - Option is enabled.
892
+ - **false** - Option is disabled.
893
+ """
894
+
895
+ value: Required[SequenceNotStr[str]]
896
+ """List of query parameters."""
897
+
898
+
899
+ class OptionsQueryStringForwarding(TypedDict, total=False):
900
+ enabled: Required[bool]
901
+ """Controls the option state.
902
+
903
+ Possible values:
904
+
905
+ - **true** - Option is enabled.
906
+ - **false** - Option is disabled.
907
+ """
908
+
909
+ forward_from_file_types: Required[SequenceNotStr[str]]
910
+ """
911
+ The `forward_from_files_types` field specifies the types of playlist files from
912
+ which parameters will be extracted and forwarded. This typically includes
913
+ formats that list multiple media chunk references, such as HLS and DASH
914
+ playlists. Parameters associated with these playlist files (like query strings
915
+ or headers) will be propagated to the chunks they reference.
916
+ """
917
+
918
+ forward_to_file_types: Required[SequenceNotStr[str]]
919
+ """
920
+ The field specifies the types of media chunk files to which parameters,
921
+ extracted from playlist files, will be forwarded. These refer to the actual
922
+ segments of media content that are delivered to viewers. Ensuring the correct
923
+ parameters are forwarded to these files is crucial for maintaining the integrity
924
+ of the streaming session.
925
+ """
926
+
927
+
928
+ class OptionsRedirectHTTPToHTTPS(TypedDict, total=False):
929
+ enabled: Required[bool]
930
+ """Controls the option state.
931
+
932
+ Possible values:
933
+
934
+ - **true** - Option is enabled.
935
+ - **false** - Option is disabled.
936
+ """
937
+
938
+ value: Required[bool]
939
+ """Possible values:
940
+
941
+ - **true** - Option is enabled.
942
+ - **false** - Option is disabled.
943
+ """
944
+
945
+
946
+ class OptionsRedirectHTTPSToHTTP(TypedDict, total=False):
947
+ enabled: Required[bool]
948
+ """Controls the option state.
949
+
950
+ Possible values:
951
+
952
+ - **true** - Option is enabled.
953
+ - **false** - Option is disabled.
954
+ """
955
+
956
+ value: Required[bool]
957
+ """Possible values:
958
+
959
+ - **true** - Option is enabled.
960
+ - **false** - Option is disabled.
961
+ """
962
+
963
+
964
+ class OptionsReferrerACL(TypedDict, total=False):
965
+ enabled: Required[bool]
966
+ """Controls the option state.
967
+
968
+ Possible values:
969
+
970
+ - **true** - Option is enabled.
971
+ - **false** - Option is disabled.
972
+ """
973
+
974
+ excepted_values: Required[SequenceNotStr[str]]
975
+ """
976
+ List of domain names or wildcard domains (without protocol: `http://` or
977
+ `https://`.)
978
+
979
+ The meaning of the parameter depends on `policy_type` value:
980
+
981
+ - **allow** - List of domain names for which access is prohibited.
982
+ - **deny** - List of IP domain names for which access is allowed.
983
+
984
+ Examples:
985
+
986
+ - `example.com`
987
+ - `\\**.example.com`
988
+ """
989
+
990
+ policy_type: Required[Literal["allow", "deny"]]
991
+ """Policy type.
992
+
993
+ Possible values:
994
+
995
+ - **allow** - Allow access to all domain names except the domain names specified
996
+ in `excepted_values` field.
997
+ - **deny** - Deny access to all domain names except the domain names specified
998
+ in `excepted_values` field.
999
+ """
1000
+
1001
+
1002
+ class OptionsRequestLimiter(TypedDict, total=False):
1003
+ enabled: Required[bool]
1004
+ """Controls the option state.
1005
+
1006
+ Possible values:
1007
+
1008
+ - **true** - Option is enabled.
1009
+ - **false** - Option is disabled.
1010
+ """
1011
+
1012
+ rate: Required[int]
1013
+ """Maximum request rate."""
1014
+
1015
+ rate_unit: Literal["r/s", "r/m"]
1016
+ """Units of measurement for the `rate` field.
1017
+
1018
+ Possible values:
1019
+
1020
+ - **r/s** - Requests per second.
1021
+ - **r/m** - Requests per minute.
1022
+
1023
+ If the rate is less than one request per second, it is specified in request per
1024
+ minute (r/m.)
1025
+ """
1026
+
1027
+
1028
+ class OptionsResponseHeadersHidingPolicy(TypedDict, total=False):
1029
+ enabled: Required[bool]
1030
+ """Controls the option state.
1031
+
1032
+ Possible values:
1033
+
1034
+ - **true** - Option is enabled.
1035
+ - **false** - Option is disabled.
1036
+ """
1037
+
1038
+ excepted: Required[SequenceNotStr[str]]
1039
+ """List of HTTP headers.
1040
+
1041
+ Parameter meaning depends on the value of the `mode` field:
1042
+
1043
+ - **show** - List of HTTP headers to hide from response.
1044
+ - **hide** - List of HTTP headers to include in response. Other HTTP headers
1045
+ will be hidden.
1046
+
1047
+ The following headers are required and cannot be hidden from response:
1048
+
1049
+ - `Connection`
1050
+ - `Content-Length`
1051
+ - `Content-Type`
1052
+ - `Date`
1053
+ - `Server`
1054
+ """
1055
+
1056
+ mode: Required[Literal["hide", "show"]]
1057
+ """How HTTP headers are hidden from the response.
1058
+
1059
+ Possible values:
1060
+
1061
+ - **show** - Hide only HTTP headers listed in the `excepted` field.
1062
+ - **hide** - Hide all HTTP headers except headers listed in the "excepted"
1063
+ field.
1064
+ """
1065
+
1066
+
1067
+ class OptionsRewrite(TypedDict, total=False):
1068
+ body: Required[str]
1069
+ """Path for the Rewrite option.
1070
+
1071
+ Example:
1072
+
1073
+ - `/(.\\**) /media/$1`
1074
+ """
1075
+
1076
+ enabled: Required[bool]
1077
+ """Controls the option state.
1078
+
1079
+ Possible values:
1080
+
1081
+ - **true** - Option is enabled.
1082
+ - **false** - Option is disabled.
1083
+ """
1084
+
1085
+ flag: Literal["break", "last", "redirect", "permanent"]
1086
+ """Flag for the Rewrite option.
1087
+
1088
+ Possible values:
1089
+
1090
+ - **last** - Stop processing the current set of `ngx_http_rewrite_module`
1091
+ directives and start a search for a new location matching changed URI.
1092
+ - **break** - Stop processing the current set of the Rewrite option.
1093
+ - **redirect** - Return a temporary redirect with the 302 code; used when a
1094
+ replacement string does not start with `http://`, `https://`, or `$scheme`.
1095
+ - **permanent** - Return a permanent redirect with the 301 code.
1096
+ """
1097
+
1098
+
1099
+ class OptionsSecureKey(TypedDict, total=False):
1100
+ enabled: Required[bool]
1101
+ """Controls the option state.
1102
+
1103
+ Possible values:
1104
+
1105
+ - **true** - Option is enabled.
1106
+ - **false** - Option is disabled.
1107
+ """
1108
+
1109
+ key: Required[Optional[str]]
1110
+ """Key generated on your side that will be used for URL signing."""
1111
+
1112
+ type: Literal[0, 2]
1113
+ """Type of URL signing.
1114
+
1115
+ Possible types:
1116
+
1117
+ - **Type 0** - Includes end user IP to secure token generation.
1118
+ - **Type 2** - Excludes end user IP from secure token generation.
1119
+ """
1120
+
1121
+
1122
+ class OptionsSlice(TypedDict, total=False):
1123
+ enabled: Required[bool]
1124
+ """Controls the option state.
1125
+
1126
+ Possible values:
1127
+
1128
+ - **true** - Option is enabled.
1129
+ - **false** - Option is disabled.
1130
+ """
1131
+
1132
+ value: Required[bool]
1133
+ """Possible values:
1134
+
1135
+ - **true** - Option is enabled.
1136
+ - **false** - Option is disabled.
1137
+ """
1138
+
1139
+
1140
+ class OptionsSni(TypedDict, total=False):
1141
+ custom_hostname: Required[str]
1142
+ """Custom SNI hostname.
1143
+
1144
+ It is required if `sni_type` is set to custom.
1145
+ """
1146
+
1147
+ enabled: Required[bool]
1148
+ """Controls the option state.
1149
+
1150
+ Possible values:
1151
+
1152
+ - **true** - Option is enabled.
1153
+ - **false** - Option is disabled.
1154
+ """
1155
+
1156
+ sni_type: Literal["dynamic", "custom"]
1157
+ """SNI (Server Name Indication) type.
1158
+
1159
+ Possible values:
1160
+
1161
+ - **dynamic** - SNI hostname depends on `hostHeader` and `forward_host_header`
1162
+ options. It has several possible combinations:
1163
+ - If the `hostHeader` option is enabled and specified, SNI hostname matches the
1164
+ Host header.
1165
+ - If the `forward_host_header` option is enabled and has true value, SNI
1166
+ hostname matches the Host header used in the request made to a CDN.
1167
+ - If the `hostHeader` and `forward_host_header` options are disabled, SNI
1168
+ hostname matches the primary CNAME.
1169
+ - **custom** - custom SNI hostname is in use.
1170
+ """
1171
+
1172
+
1173
+ class OptionsStale(TypedDict, total=False):
1174
+ enabled: Required[bool]
1175
+ """Controls the option state.
1176
+
1177
+ Possible values:
1178
+
1179
+ - **true** - Option is enabled.
1180
+ - **false** - Option is disabled.
1181
+ """
1182
+
1183
+ value: Required[
1184
+ List[
1185
+ Literal[
1186
+ "error",
1187
+ "http_403",
1188
+ "http_404",
1189
+ "http_429",
1190
+ "http_500",
1191
+ "http_502",
1192
+ "http_503",
1193
+ "http_504",
1194
+ "invalid_header",
1195
+ "timeout",
1196
+ "updating",
1197
+ ]
1198
+ ]
1199
+ ]
1200
+ """Defines list of errors for which "Always online" option is applied."""
1201
+
1202
+
1203
+ class OptionsStaticResponseHeadersValue(TypedDict, total=False):
1204
+ name: Required[str]
1205
+ """HTTP Header name.
1206
+
1207
+ Restrictions:
1208
+
1209
+ - Maximum 128 symbols.
1210
+ - Latin letters (A-Z, a-z,) numbers (0-9,) dashes, and underscores only.
1211
+ """
1212
+
1213
+ value: Required[SequenceNotStr[str]]
1214
+ """Header value.
1215
+
1216
+ Restrictions:
1217
+
1218
+ - Maximum 512 symbols.
1219
+ - Letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&\\**()-\\__=+
1220
+ /|\";:?.,><{}[]).
1221
+ - Must start with a letter, number, asterisk or {.
1222
+ - Multiple values can be added.
1223
+ """
1224
+
1225
+ always: bool
1226
+ """
1227
+ Defines whether the header will be added to a response from CDN regardless of
1228
+ response code.
1229
+
1230
+ Possible values:
1231
+
1232
+ - **true** - Header will be added to a response from CDN regardless of response
1233
+ code.
1234
+ - **false** - Header will be added only to the following response codes: 200,
1235
+ 201, 204, 206, 301, 302, 303, 304, 307, 308.
1236
+ """
1237
+
1238
+
1239
+ class OptionsStaticResponseHeaders(TypedDict, total=False):
1240
+ enabled: Required[bool]
1241
+ """Controls the option state.
1242
+
1243
+ Possible values:
1244
+
1245
+ - **true** - Option is enabled.
1246
+ - **false** - Option is disabled.
1247
+ """
1248
+
1249
+ value: Required[Iterable[OptionsStaticResponseHeadersValue]]
1250
+
1251
+
1252
+ class OptionsStaticHeaders(TypedDict, total=False):
1253
+ enabled: Required[bool]
1254
+ """Controls the option state.
1255
+
1256
+ Possible values:
1257
+
1258
+ - **true** - Option is enabled.
1259
+ - **false** - Option is disabled.
1260
+ """
1261
+
1262
+ value: Required[Dict[str, str]]
1263
+ """A MAP for static headers in a format of `header_name: header_value`.
1264
+
1265
+ Restrictions:
1266
+
1267
+ - **Header name** - Maximum 128 symbols, may contain Latin letters (A-Z, a-z),
1268
+ numbers (0-9), dashes, and underscores.
1269
+ - **Header value** - Maximum 512 symbols, may contain letters (a-z), numbers
1270
+ (0-9), spaces, and symbols (`~!@#%%^&\\**()-\\__=+ /|\";:?.,><{}[]). Must start
1271
+ with a letter, number, asterisk or {.
1272
+ """
1273
+
1274
+
1275
+ class OptionsStaticRequestHeaders(TypedDict, total=False):
1276
+ enabled: Required[bool]
1277
+ """Controls the option state.
1278
+
1279
+ Possible values:
1280
+
1281
+ - **true** - Option is enabled.
1282
+ - **false** - Option is disabled.
1283
+ """
1284
+
1285
+ value: Required[Dict[str, str]]
1286
+ """A MAP for static headers in a format of `header_name: header_value`.
1287
+
1288
+ Restrictions:
1289
+
1290
+ - **Header name** - Maximum 255 symbols, may contain Latin letters (A-Z, a-z),
1291
+ numbers (0-9), dashes, and underscores.
1292
+ - **Header value** - Maximum 512 symbols, may contain letters (a-z), numbers
1293
+ (0-9), spaces, and symbols (`~!@#%%^&\\**()-\\__=+ /|\";:?.,><{}[]). Must start
1294
+ with a letter, number, asterisk or {.
1295
+ """
1296
+
1297
+
1298
+ class OptionsTlsVersions(TypedDict, total=False):
1299
+ enabled: Required[bool]
1300
+ """Controls the option state.
1301
+
1302
+ Possible values:
1303
+
1304
+ - **true** - Option is enabled.
1305
+ - **false** - Option is disabled.
1306
+ """
1307
+
1308
+ value: Required[List[Literal["SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2", "TLSv1.3"]]]
1309
+ """List of SSL/TLS protocol versions (case sensitive)."""
1310
+
1311
+
1312
+ class OptionsUseDefaultLeChain(TypedDict, total=False):
1313
+ enabled: Required[bool]
1314
+ """Controls the option state.
1315
+
1316
+ Possible values:
1317
+
1318
+ - **true** - Option is enabled.
1319
+ - **false** - Option is disabled.
1320
+ """
1321
+
1322
+ value: Required[bool]
1323
+ """Possible values:
1324
+
1325
+ - **true** - Default Let's Encrypt certificate chain. This is a deprecated
1326
+ version, use it only for compatibilities with Android devices 7.1.1 or lower.
1327
+ - **false** - Alternative Let's Encrypt certificate chain.
1328
+ """
1329
+
1330
+
1331
+ class OptionsUseDns01LeChallenge(TypedDict, total=False):
1332
+ enabled: Required[bool]
1333
+ """Controls the option state.
1334
+
1335
+ Possible values:
1336
+
1337
+ - **true** - Option is enabled.
1338
+ - **false** - Option is disabled.
1339
+ """
1340
+
1341
+ value: Required[bool]
1342
+ """Possible values:
1343
+
1344
+ - **true** - DNS-01 challenge is used to issue Let's Encrypt certificate.
1345
+ - **false** - HTTP-01 challenge is used to issue Let's Encrypt certificate.
1346
+ """
1347
+
1348
+
1349
+ class OptionsUseRsaLeCert(TypedDict, total=False):
1350
+ enabled: Required[bool]
1351
+ """Controls the option state.
1352
+
1353
+ Possible values:
1354
+
1355
+ - **true** - Option is enabled.
1356
+ - **false** - Option is disabled.
1357
+ """
1358
+
1359
+ value: Required[bool]
1360
+ """Possible values:
1361
+
1362
+ - **true** - RSA Let's Encrypt certificate.
1363
+ - **false** - ECDSA Let's Encrypt certificate.
1364
+ """
1365
+
1366
+
1367
+ class OptionsUserAgentACL(TypedDict, total=False):
1368
+ enabled: Required[bool]
1369
+ """Controls the option state.
1370
+
1371
+ Possible values:
1372
+
1373
+ - **true** - Option is enabled.
1374
+ - **false** - Option is disabled.
1375
+ """
1376
+
1377
+ excepted_values: Required[SequenceNotStr[str]]
1378
+ """List of User-Agents that will be allowed/denied.
1379
+
1380
+ The meaning of the parameter depends on `policy_type`:
1381
+
1382
+ - **allow** - List of User-Agents for which access is prohibited.
1383
+ - **deny** - List of User-Agents for which access is allowed.
1384
+
1385
+ Use an empty string `""` to allow/deny access when the User-Agent header is
1386
+ empty.
1387
+ """
1388
+
1389
+ policy_type: Required[Literal["allow", "deny"]]
1390
+ """User-Agents policy type.
1391
+
1392
+ Possible values:
1393
+
1394
+ - **allow** - Allow access for all User-Agents except specified in
1395
+ `excepted_values` field.
1396
+ - **deny** - Deny access for all User-Agents except specified in
1397
+ `excepted_values` field.
1398
+ """
1399
+
1400
+
1401
+ class OptionsWaap(TypedDict, total=False):
1402
+ enabled: Required[bool]
1403
+ """Controls the option state.
1404
+
1405
+ Possible values:
1406
+
1407
+ - **true** - Option is enabled.
1408
+ - **false** - Option is disabled.
1409
+ """
1410
+
1411
+ value: Required[bool]
1412
+ """Possible values:
1413
+
1414
+ - **true** - Option is enabled.
1415
+ - **false** - Option is disabled.
1416
+ """
1417
+
1418
+
1419
+ class OptionsWebsockets(TypedDict, total=False):
1420
+ enabled: Required[bool]
1421
+ """Controls the option state.
1422
+
1423
+ Possible values:
1424
+
1425
+ - **true** - Option is enabled.
1426
+ - **false** - Option is disabled.
1427
+ """
1428
+
1429
+ value: Required[bool]
1430
+ """Possible values:
1431
+
1432
+ - **true** - Option is enabled.
1433
+ - **false** - Option is disabled.
1434
+ """
1435
+
1436
+
1437
+ class Options(TypedDict, total=False):
1438
+ allowed_http_methods: Annotated[Optional[OptionsAllowedHTTPMethods], PropertyInfo(alias="allowedHttpMethods")]
1439
+ """HTTP methods allowed for content requests from the CDN."""
1440
+
1441
+ bot_protection: Optional[OptionsBotProtection]
1442
+ """
1443
+ Allows to prevent online services from overloading and ensure your business
1444
+ workflow running smoothly.
1445
+ """
1446
+
1447
+ brotli_compression: Optional[OptionsBrotliCompression]
1448
+ """Compresses content with Brotli on the CDN side.
1449
+
1450
+ CDN servers will request only uncompressed content from the origin.
1451
+
1452
+ Notes:
1453
+
1454
+ 1. CDN only supports "Brotli compression" when the "origin shielding" feature is
1455
+ activated.
1456
+ 2. If a precache server is not active for a CDN resource, no compression occurs,
1457
+ even if the option is enabled.
1458
+ 3. `brotli_compression` is not supported with `fetch_compressed` or `slice`
1459
+ options enabled.
1460
+ 4. `fetch_compressed` option in CDN resource settings overrides
1461
+ `brotli_compression` in rules. If you enabled `fetch_compressed` in CDN
1462
+ resource and want to enable `brotli_compression` in a rule, you must specify
1463
+ `fetch_compressed:false` in the rule.
1464
+ """
1465
+
1466
+ browser_cache_settings: Optional[OptionsBrowserCacheSettings]
1467
+ """Cache expiration time for users browsers in seconds.
1468
+
1469
+ Cache expiration time is applied to the following response codes: 200, 201, 204,
1470
+ 206, 301, 302, 303, 304, 307, 308.
1471
+
1472
+ Responses with other codes will not be cached.
1473
+ """
1474
+
1475
+ cache_http_headers: Optional[OptionsCacheHTTPHeaders]
1476
+ """**Legacy option**. Use the `response_headers_hiding_policy` option instead.
1477
+
1478
+ HTTP Headers that must be included in the response.
1479
+ """
1480
+
1481
+ cors: Optional[OptionsCors]
1482
+ """Enables or disables CORS (Cross-Origin Resource Sharing) header support.
1483
+
1484
+ CORS header support allows the CDN to add the Access-Control-Allow-Origin header
1485
+ to a response to a browser.
1486
+ """
1487
+
1488
+ country_acl: Optional[OptionsCountryACL]
1489
+ """Enables control access to content for specified countries."""
1490
+
1491
+ disable_cache: Optional[OptionsDisableCache]
1492
+ """**Legacy option**. Use the `edge_cache_settings` option instead.
1493
+
1494
+ Allows the complete disabling of content caching.
1495
+ """
1496
+
1497
+ disable_proxy_force_ranges: Optional[OptionsDisableProxyForceRanges]
1498
+ """Allows 206 responses regardless of the settings of an origin source."""
1499
+
1500
+ edge_cache_settings: Optional[OptionsEdgeCacheSettings]
1501
+ """Cache expiration time for CDN servers.
1502
+
1503
+ `value` and `default` fields cannot be used simultaneously.
1504
+ """
1505
+
1506
+ fastedge: Optional[OptionsFastedge]
1507
+ """
1508
+ Allows to configure FastEdge app to be called on different request/response
1509
+ phases.
1510
+
1511
+ Note: At least one of `on_request_headers`, `on_request_body`,
1512
+ `on_response_headers`, or `on_response_body` must be specified.
1513
+ """
1514
+
1515
+ fetch_compressed: Optional[OptionsFetchCompressed]
1516
+ """Makes the CDN request compressed content from the origin.
1517
+
1518
+ The origin server should support compression. CDN servers will not decompress
1519
+ your content even if a user browser does not accept compression.
1520
+
1521
+ Notes:
1522
+
1523
+ 1. `fetch_compressed` is not supported with `gzipON` or `brotli_compression` or
1524
+ `slice` options enabled.
1525
+ 2. `fetch_compressed` overrides `gzipON` and `brotli_compression` in rule. If
1526
+ you enable it in CDN resource and want to use `gzipON` and
1527
+ `brotli_compression` in a rule, you have to specify
1528
+ `"`fetch_compressed`": false` in the rule.
1529
+ """
1530
+
1531
+ follow_origin_redirect: Optional[OptionsFollowOriginRedirect]
1532
+ """
1533
+ Enables redirection from origin. If the origin server returns a redirect, the
1534
+ option allows the CDN to pull the requested content from the origin server that
1535
+ was returned in the redirect.
1536
+ """
1537
+
1538
+ force_return: Optional[OptionsForceReturn]
1539
+ """Applies custom HTTP response codes for CDN content.
1540
+
1541
+ The following codes are reserved by our system and cannot be specified in this
1542
+ option: 408, 444, 477, 494, 495, 496, 497, 499.
1543
+ """
1544
+
1545
+ forward_host_header: Optional[OptionsForwardHostHeader]
1546
+ """Forwards the Host header from a end-user request to an origin server.
1547
+
1548
+ `hostHeader` and `forward_host_header` options cannot be enabled simultaneously.
1549
+ """
1550
+
1551
+ gzip_on: Annotated[Optional[OptionsGzipOn], PropertyInfo(alias="gzipOn")]
1552
+ """Compresses content with gzip on the CDN end.
1553
+
1554
+ CDN servers will request only uncompressed content from the origin.
1555
+
1556
+ Notes:
1557
+
1558
+ 1. Compression with gzip is not supported with `fetch_compressed` or `slice`
1559
+ options enabled.
1560
+ 2. `fetch_compressed` option in CDN resource settings overrides `gzipON` in
1561
+ rules. If you enable `fetch_compressed` in CDN resource and want to enable
1562
+ `gzipON` in rules, you need to specify `"`fetch_compressed`":false` for
1563
+ rules.
1564
+ """
1565
+
1566
+ host_header: Annotated[Optional[OptionsHostHeader], PropertyInfo(alias="hostHeader")]
1567
+ """
1568
+ Sets the Host header that CDN servers use when request content from an origin
1569
+ server. Your server must be able to process requests with the chosen header.
1570
+
1571
+ If the option is `null`, the Host Header value is equal to first CNAME.
1572
+
1573
+ `hostHeader` and `forward_host_header` options cannot be enabled simultaneously.
1574
+ """
1575
+
1576
+ http3_enabled: Optional[OptionsHttp3Enabled]
1577
+ """Enables HTTP/3 protocol for content delivery.
1578
+
1579
+ `http3_enabled` option works only with `"sslEnabled": true`.
1580
+ """
1581
+
1582
+ ignore_cookie: Optional[OptionsIgnoreCookie]
1583
+ """
1584
+ Defines whether the files with the Set-Cookies header are cached as one file or
1585
+ as different ones.
1586
+ """
1587
+
1588
+ ignore_query_string: Annotated[Optional[OptionsIgnoreQueryString], PropertyInfo(alias="ignoreQueryString")]
1589
+ """
1590
+ How a file with different query strings is cached: either as one object (option
1591
+ is enabled) or as different objects (option is disabled.)
1592
+
1593
+ `ignoreQueryString`, `query_params_whitelist` and `query_params_blacklist`
1594
+ options cannot be enabled simultaneously.
1595
+ """
1596
+
1597
+ image_stack: Optional[OptionsImageStack]
1598
+ """
1599
+ Transforms JPG and PNG images (for example, resize or crop) and automatically
1600
+ converts them to WebP or AVIF format.
1601
+ """
1602
+
1603
+ ip_address_acl: Optional[OptionsIPAddressACL]
1604
+ """Controls access to the CDN resource content for specific IP addresses.
1605
+
1606
+ If you want to use IPs from our CDN servers IP list for IP ACL configuration,
1607
+ you have to independently monitor their relevance. We recommend you use a script
1608
+ for automatically update IP ACL.
1609
+ [Read more.](/docs/api-reference/cdn/ip-addresses-list/get-cdn-servers-ip-addresses)
1610
+ """
1611
+
1612
+ limit_bandwidth: Optional[OptionsLimitBandwidth]
1613
+ """Allows to control the download speed per connection."""
1614
+
1615
+ proxy_cache_key: Optional[OptionsProxyCacheKey]
1616
+ """Allows you to modify your cache key.
1617
+
1618
+ If omitted, the default value is `$request_uri`.
1619
+
1620
+ Combine the specified variables to create a key for caching.
1621
+
1622
+ - **$`request_uri`**
1623
+ - **$scheme**
1624
+ - **$uri**
1625
+
1626
+ **Warning**: Enabling and changing this option can invalidate your current cache
1627
+ and affect the cache hit ratio. Furthermore, the "Purge by pattern" option will
1628
+ not work.
1629
+ """
1630
+
1631
+ proxy_cache_methods_set: Optional[OptionsProxyCacheMethodsSet]
1632
+ """Caching for POST requests along with default GET and HEAD."""
1633
+
1634
+ proxy_connect_timeout: Optional[OptionsProxyConnectTimeout]
1635
+ """The time limit for establishing a connection with the origin."""
1636
+
1637
+ proxy_read_timeout: Optional[OptionsProxyReadTimeout]
1638
+ """
1639
+ The time limit for receiving a partial response from the origin. If no response
1640
+ is received within this time, the connection will be closed.
1641
+
1642
+ **Note:** When used with a WebSocket connection, this option supports values
1643
+ only in the range 1–20 seconds (instead of the usual 1–30 seconds).
1644
+ """
1645
+
1646
+ query_params_blacklist: Optional[OptionsQueryParamsBlacklist]
1647
+ """
1648
+ Files with the specified query parameters are cached as one object, files with
1649
+ other parameters are cached as different objects.
1650
+
1651
+ `ignoreQueryString`, `query_params_whitelist` and `query_params_blacklist`
1652
+ options cannot be enabled simultaneously.
1653
+ """
1654
+
1655
+ query_params_whitelist: Optional[OptionsQueryParamsWhitelist]
1656
+ """
1657
+ Files with the specified query parameters are cached as different objects, files
1658
+ with other parameters are cached as one object.
1659
+
1660
+ `ignoreQueryString`, `query_params_whitelist` and `query_params_blacklist`
1661
+ options cannot be enabled simultaneously.
1662
+ """
1663
+
1664
+ query_string_forwarding: Optional[OptionsQueryStringForwarding]
1665
+ """
1666
+ The Query String Forwarding feature allows for the seamless transfer of
1667
+ parameters embedded in playlist files to the corresponding media chunk files.
1668
+ This functionality ensures that specific attributes, such as authentication
1669
+ tokens or tracking information, are consistently passed along from the playlist
1670
+ manifest to the individual media segments. This is particularly useful for
1671
+ maintaining continuity in security, analytics, and any other parameter-based
1672
+ operations across the entire media delivery workflow.
1673
+ """
1674
+
1675
+ redirect_http_to_https: Optional[OptionsRedirectHTTPToHTTPS]
1676
+ """Enables redirect from HTTP to HTTPS.
1677
+
1678
+ `redirect_http_to_https` and `redirect_https_to_http` options cannot be enabled
1679
+ simultaneously.
1680
+ """
1681
+
1682
+ redirect_https_to_http: Optional[OptionsRedirectHTTPSToHTTP]
1683
+ """Enables redirect from HTTPS to HTTP.
1684
+
1685
+ `redirect_http_to_https` and `redirect_https_to_http` options cannot be enabled
1686
+ simultaneously.
1687
+ """
1688
+
1689
+ referrer_acl: Optional[OptionsReferrerACL]
1690
+ """Controls access to the CDN resource content for specified domain names."""
1691
+
1692
+ request_limiter: Optional[OptionsRequestLimiter]
1693
+ """Option allows to limit the amount of HTTP requests."""
1694
+
1695
+ response_headers_hiding_policy: Optional[OptionsResponseHeadersHidingPolicy]
1696
+ """Hides HTTP headers from an origin server in the CDN response."""
1697
+
1698
+ rewrite: Optional[OptionsRewrite]
1699
+ """Changes and redirects requests from the CDN to the origin.
1700
+
1701
+ It operates according to the
1702
+ [Nginx](https://nginx.org/en/docs/http/ngx_http_rewrite_module.html#rewrite)
1703
+ configuration.
1704
+ """
1705
+
1706
+ secure_key: Optional[OptionsSecureKey]
1707
+ """Configures access with tokenized URLs.
1708
+
1709
+ This makes impossible to access content without a valid (unexpired) token.
1710
+ """
1711
+
1712
+ slice: Optional[OptionsSlice]
1713
+ """
1714
+ Requests and caches files larger than 10 MB in parts (no larger than 10 MB per
1715
+ part.) This reduces time to first byte.
1716
+
1717
+ The option is based on the
1718
+ [Slice](https://nginx.org/en/docs/http/ngx_http_slice_module.html) module.
1719
+
1720
+ Notes:
1721
+
1722
+ 1. Origin must support HTTP Range requests.
1723
+ 2. Not supported with `gzipON`, `brotli_compression` or `fetch_compressed`
1724
+ options enabled.
1725
+ """
1726
+
1727
+ sni: Optional[OptionsSni]
1728
+ """
1729
+ The hostname that is added to SNI requests from CDN servers to the origin server
1730
+ via HTTPS.
1731
+
1732
+ SNI is generally only required if your origin uses shared hosting or does not
1733
+ have a dedicated IP address. If the origin server presents multiple
1734
+ certificates, SNI allows the origin server to know which certificate to use for
1735
+ the connection.
1736
+
1737
+ The option works only if `originProtocol` parameter is `HTTPS` or `MATCH`.
1738
+ """
1739
+
1740
+ stale: Optional[OptionsStale]
1741
+ """Serves stale cached content in case of origin unavailability."""
1742
+
1743
+ static_response_headers: Optional[OptionsStaticResponseHeaders]
1744
+ """Custom HTTP Headers that a CDN server adds to a response."""
1745
+
1746
+ static_headers: Annotated[Optional[OptionsStaticHeaders], PropertyInfo(alias="staticHeaders")]
1747
+ """**Legacy option**. Use the `static_response_headers` option instead.
1748
+
1749
+ Custom HTTP Headers that a CDN server adds to response. Up to fifty custom HTTP
1750
+ Headers can be specified. May contain a header with multiple values.
1751
+ """
1752
+
1753
+ static_request_headers: Annotated[Optional[OptionsStaticRequestHeaders], PropertyInfo(alias="staticRequestHeaders")]
1754
+ """Custom HTTP Headers for a CDN server to add to request.
1755
+
1756
+ Up to fifty custom HTTP Headers can be specified.
1757
+ """
1758
+
1759
+ tls_versions: Optional[OptionsTlsVersions]
1760
+ """
1761
+ List of SSL/TLS protocol versions allowed for HTTPS connections from end users
1762
+ to the domain.
1763
+
1764
+ When the option is disabled, all protocols versions are allowed.
1765
+ """
1766
+
1767
+ use_default_le_chain: Optional[OptionsUseDefaultLeChain]
1768
+ """Let's Encrypt certificate chain.
1769
+
1770
+ The specified chain will be used during the next Let's Encrypt certificate issue
1771
+ or renewal.
1772
+ """
1773
+
1774
+ use_dns01_le_challenge: Optional[OptionsUseDns01LeChallenge]
1775
+ """DNS-01 challenge to issue a Let's Encrypt certificate for the resource.
1776
+
1777
+ DNS service should be activated to enable this option.
1778
+ """
1779
+
1780
+ use_rsa_le_cert: Optional[OptionsUseRsaLeCert]
1781
+ """RSA Let's Encrypt certificate type for the CDN resource.
1782
+
1783
+ The specified value will be used during the next Let's Encrypt certificate issue
1784
+ or renewal.
1785
+ """
1786
+
1787
+ user_agent_acl: Optional[OptionsUserAgentACL]
1788
+ """Controls access to the content for specified User-Agents."""
1789
+
1790
+ waap: Optional[OptionsWaap]
1791
+ """Allows to enable WAAP (Web Application and API Protection)."""
1792
+
1793
+ websockets: Optional[OptionsWebsockets]
1794
+ """Enables or disables WebSockets connections to an origin server."""