gcore 0.2.0__py3-none-any.whl → 0.3.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 (258) hide show
  1. gcore/_base_client.py +22 -2
  2. gcore/_models.py +2 -0
  3. gcore/_types.py +2 -0
  4. gcore/_version.py +1 -1
  5. gcore/resources/cloud/baremetal/flavors.py +2 -2
  6. gcore/resources/cloud/baremetal/images.py +2 -2
  7. gcore/resources/cloud/baremetal/servers.py +46 -52
  8. gcore/resources/cloud/floating_ips.py +4 -4
  9. gcore/resources/cloud/gpu_baremetal_clusters/gpu_baremetal_clusters.py +8 -8
  10. gcore/resources/cloud/gpu_baremetal_clusters/images.py +2 -2
  11. gcore/resources/cloud/gpu_baremetal_clusters/servers.py +4 -4
  12. gcore/resources/cloud/inference/deployments/deployments.py +6 -6
  13. gcore/resources/cloud/instances/flavors.py +2 -2
  14. gcore/resources/cloud/instances/images.py +2 -2
  15. gcore/resources/cloud/instances/instances.py +62 -70
  16. gcore/resources/cloud/instances/interfaces.py +4 -4
  17. gcore/resources/cloud/load_balancers/flavors.py +2 -2
  18. gcore/resources/cloud/load_balancers/l7_policies/l7_policies.py +20 -20
  19. gcore/resources/cloud/load_balancers/listeners.py +14 -14
  20. gcore/resources/cloud/load_balancers/load_balancers.py +28 -24
  21. gcore/resources/cloud/load_balancers/pools/members.py +6 -6
  22. gcore/resources/cloud/networks/networks.py +4 -4
  23. gcore/resources/cloud/networks/subnets.py +6 -6
  24. gcore/resources/cloud/registries/registries.py +6 -10
  25. gcore/resources/cloud/registries/users.py +4 -10
  26. gcore/resources/cloud/reserved_fixed_ips/reserved_fixed_ips.py +10 -10
  27. gcore/resources/cloud/security_groups/security_groups.py +2 -2
  28. gcore/resources/cloud/ssh_keys.py +2 -2
  29. gcore/resources/cloud/tasks.py +98 -90
  30. gcore/resources/cloud/users/role_assignments.py +4 -4
  31. gcore/resources/cloud/volumes.py +18 -18
  32. gcore/resources/waap/__init__.py +98 -0
  33. gcore/resources/waap/advanced_rules.py +135 -0
  34. gcore/resources/waap/clients.py +135 -0
  35. gcore/resources/waap/custom_page_sets.py +805 -0
  36. gcore/resources/waap/domains/__init__.py +140 -0
  37. gcore/resources/waap/domains/advanced_rules.py +876 -0
  38. gcore/resources/waap/domains/analytics/__init__.py +33 -0
  39. gcore/resources/waap/domains/analytics/analytics.py +676 -0
  40. gcore/resources/waap/domains/analytics/requests.py +378 -0
  41. gcore/resources/waap/domains/api_discovery/__init__.py +33 -0
  42. gcore/resources/waap/domains/api_discovery/api_discovery.py +530 -0
  43. gcore/resources/waap/domains/api_discovery/scan_results.py +352 -0
  44. gcore/resources/waap/domains/api_path_groups.py +163 -0
  45. gcore/resources/waap/domains/api_paths.py +771 -0
  46. gcore/resources/waap/domains/custom_rules.py +889 -0
  47. gcore/resources/waap/domains/domains.py +399 -0
  48. gcore/resources/waap/domains/firewall_rules.py +884 -0
  49. gcore/resources/waap/domains/insight_silences.py +689 -0
  50. gcore/resources/waap/domains/insights.py +425 -0
  51. gcore/resources/waap/domains/policies.py +173 -0
  52. gcore/resources/waap/domains/settings.py +5 -5
  53. gcore/resources/waap/ip_info.py +1017 -0
  54. gcore/resources/waap/organizations.py +217 -0
  55. gcore/resources/waap/statistics.py +225 -0
  56. gcore/resources/waap/tags.py +233 -0
  57. gcore/resources/waap/waap.py +289 -0
  58. gcore/types/cloud/allowed_address_pairs.py +2 -2
  59. gcore/types/cloud/baremetal/baremetal_server.py +1 -1
  60. gcore/types/cloud/baremetal/image_list_params.py +1 -1
  61. gcore/types/cloud/baremetal/server_create_params.py +9 -9
  62. gcore/types/cloud/baremetal/server_list_params.py +8 -8
  63. gcore/types/cloud/baremetal/server_rebuild_params.py +1 -1
  64. gcore/types/cloud/baremetal_flavor.py +3 -3
  65. gcore/types/cloud/container_probe_config.py +1 -1
  66. gcore/types/cloud/container_probe_config_create_param.py +1 -1
  67. gcore/types/cloud/container_scale_triggers.py +2 -2
  68. gcore/types/cloud/floating_ip_detailed.py +1 -1
  69. gcore/types/cloud/floating_ip_list_params.py +2 -2
  70. gcore/types/cloud/gpu_baremetal_cluster.py +1 -1
  71. gcore/types/cloud/gpu_baremetal_cluster_create_params.py +2 -2
  72. gcore/types/cloud/gpu_baremetal_cluster_delete_params.py +1 -1
  73. gcore/types/cloud/gpu_baremetal_cluster_rebuild_params.py +1 -1
  74. gcore/types/cloud/gpu_baremetal_cluster_server.py +1 -1
  75. gcore/types/cloud/gpu_baremetal_clusters/image_upload_params.py +1 -1
  76. gcore/types/cloud/gpu_baremetal_clusters/server_attach_interface_params.py +10 -10
  77. gcore/types/cloud/gpu_baremetal_flavor.py +3 -3
  78. gcore/types/cloud/image.py +1 -1
  79. gcore/types/cloud/inference/deployment_create_params.py +4 -4
  80. gcore/types/cloud/inference/deployment_update_params.py +6 -6
  81. gcore/types/cloud/inference/inference.py +2 -4
  82. gcore/types/cloud/instance.py +1 -1
  83. gcore/types/cloud/instance_create_params.py +8 -10
  84. gcore/types/cloud/instance_list_params.py +8 -8
  85. gcore/types/cloud/instances/flavor_list_suitable_params.py +4 -1
  86. gcore/types/cloud/instances/image_list_params.py +1 -1
  87. gcore/types/cloud/instances/instance_flavor.py +3 -3
  88. gcore/types/cloud/instances/interface_attach_params.py +10 -10
  89. gcore/types/cloud/load_balancer_create_params.py +17 -15
  90. gcore/types/cloud/load_balancer_flavor_detail.py +3 -3
  91. gcore/types/cloud/load_balancer_l7_policy.py +5 -5
  92. gcore/types/cloud/load_balancer_list_params.py +5 -5
  93. gcore/types/cloud/load_balancer_listener_detail.py +4 -4
  94. gcore/types/cloud/load_balancers/l7_policy_create_params.py +5 -5
  95. gcore/types/cloud/load_balancers/l7_policy_replace_params.py +5 -5
  96. gcore/types/cloud/load_balancers/listener_create_params.py +4 -4
  97. gcore/types/cloud/load_balancers/listener_update_params.py +3 -3
  98. gcore/types/cloud/load_balancers/pool_create_params.py +4 -4
  99. gcore/types/cloud/load_balancers/pool_update_params.py +4 -4
  100. gcore/types/cloud/load_balancers/pools/member_add_params.py +3 -3
  101. gcore/types/cloud/member.py +2 -2
  102. gcore/types/cloud/network.py +2 -2
  103. gcore/types/cloud/network_details.py +2 -2
  104. gcore/types/cloud/network_list_params.py +2 -2
  105. gcore/types/cloud/networks/subnet_create_params.py +1 -1
  106. gcore/types/cloud/networks/subnet_list_params.py +2 -2
  107. gcore/types/cloud/region.py +4 -4
  108. gcore/types/cloud/registries/user_create_multiple_params.py +3 -5
  109. gcore/types/cloud/registries/user_create_params.py +3 -5
  110. gcore/types/cloud/registry_create_params.py +3 -5
  111. gcore/types/cloud/reserved_fixed_ip_create_params.py +2 -2
  112. gcore/types/cloud/reserved_fixed_ip_list_params.py +3 -3
  113. gcore/types/cloud/security_group_list_params.py +1 -1
  114. gcore/types/cloud/session_persistence.py +1 -1
  115. gcore/types/cloud/ssh_key_created.py +3 -6
  116. gcore/types/cloud/task.py +1 -1
  117. gcore/types/cloud/task_list_params.py +49 -45
  118. gcore/types/cloud/users/role_assignment_create_params.py +1 -1
  119. gcore/types/cloud/users/role_assignment_update_params.py +1 -1
  120. gcore/types/cloud/volume_create_params.py +6 -6
  121. gcore/types/cloud/volume_list_params.py +3 -3
  122. gcore/types/waap/__init__.py +98 -2
  123. gcore/types/waap/client_me_response.py +34 -0
  124. gcore/types/waap/custom_page_set_create_params.py +35 -0
  125. gcore/types/waap/custom_page_set_list_params.py +25 -0
  126. gcore/types/waap/custom_page_set_preview_params.py +34 -0
  127. gcore/types/waap/custom_page_set_update_params.py +35 -0
  128. gcore/types/waap/domain_list_rule_sets_response.py +10 -0
  129. gcore/types/waap/domains/__init__.py +42 -0
  130. gcore/types/waap/domains/advanced_rule_create_params.py +80 -0
  131. gcore/types/waap/domains/advanced_rule_list_params.py +58 -0
  132. gcore/types/waap/domains/advanced_rule_update_params.py +83 -0
  133. gcore/types/waap/domains/analytics/__init__.py +5 -0
  134. gcore/types/waap/domains/analytics/request_list_params.py +53 -0
  135. gcore/types/waap/domains/analytics_get_event_statistics_params.py +34 -0
  136. gcore/types/waap/domains/analytics_list_ddos_attacks_params.py +28 -0
  137. gcore/types/waap/domains/analytics_list_ddos_info_params.py +31 -0
  138. gcore/types/waap/domains/analytics_list_event_traffic_params.py +26 -0
  139. gcore/types/waap/domains/analytics_list_event_traffic_response.py +10 -0
  140. gcore/types/waap/domains/api_discovery/__init__.py +7 -0
  141. gcore/types/waap/domains/api_discovery/scan_result_get_response.py +29 -0
  142. gcore/types/waap/domains/api_discovery/scan_result_list_params.py +41 -0
  143. gcore/types/waap/domains/api_discovery/scan_result_list_response.py +29 -0
  144. gcore/types/waap/domains/api_discovery_get_settings_response.py +36 -0
  145. gcore/types/waap/domains/api_discovery_scan_openapi_response.py +10 -0
  146. gcore/types/waap/domains/api_discovery_update_settings_params.py +34 -0
  147. gcore/types/waap/domains/api_discovery_update_settings_response.py +36 -0
  148. gcore/types/waap/domains/api_discovery_upload_openapi_params.py +19 -0
  149. gcore/types/waap/domains/api_discovery_upload_openapi_response.py +10 -0
  150. gcore/types/waap/domains/api_path_create_params.py +31 -0
  151. gcore/types/waap/domains/api_path_create_response.py +50 -0
  152. gcore/types/waap/domains/api_path_get_response.py +50 -0
  153. gcore/types/waap/domains/api_path_group_list_response.py +12 -0
  154. gcore/types/waap/domains/api_path_list_params.py +62 -0
  155. gcore/types/waap/domains/api_path_list_response.py +50 -0
  156. gcore/types/waap/domains/api_path_update_params.py +29 -0
  157. gcore/types/waap/domains/custom_rule_create_params.py +368 -0
  158. gcore/types/waap/domains/custom_rule_delete_multiple_params.py +13 -0
  159. gcore/types/waap/domains/custom_rule_list_params.py +35 -0
  160. gcore/types/waap/domains/custom_rule_update_params.py +371 -0
  161. gcore/types/waap/domains/firewall_rule_create_params.py +75 -0
  162. gcore/types/waap/domains/firewall_rule_delete_multiple_params.py +13 -0
  163. gcore/types/waap/domains/firewall_rule_list_params.py +33 -0
  164. gcore/types/waap/domains/firewall_rule_update_params.py +78 -0
  165. gcore/types/waap/domains/insight_list_params.py +34 -0
  166. gcore/types/waap/domains/insight_replace_params.py +17 -0
  167. gcore/types/waap/domains/insight_silence_create_params.py +28 -0
  168. gcore/types/waap/domains/insight_silence_list_params.py +33 -0
  169. gcore/types/waap/domains/insight_silence_update_params.py +28 -0
  170. gcore/types/waap/domains/setting_update_params.py +7 -0
  171. gcore/types/waap/ip_info_get_attack_time_series_params.py +12 -0
  172. gcore/types/waap/ip_info_get_attack_time_series_response.py +10 -0
  173. gcore/types/waap/ip_info_get_blocked_requests_params.py +15 -0
  174. gcore/types/waap/ip_info_get_blocked_requests_response.py +10 -0
  175. gcore/types/waap/ip_info_get_counts_params.py +19 -0
  176. gcore/types/waap/ip_info_get_ddos_attack_series_params.py +12 -0
  177. gcore/types/waap/ip_info_get_params.py +12 -0
  178. gcore/types/waap/ip_info_get_top_sessions_params.py +15 -0
  179. gcore/types/waap/ip_info_get_top_sessions_response.py +10 -0
  180. gcore/types/waap/ip_info_get_top_urls_params.py +15 -0
  181. gcore/types/waap/ip_info_get_top_urls_response.py +10 -0
  182. gcore/types/waap/ip_info_get_top_user_agents_params.py +15 -0
  183. gcore/types/waap/ip_info_get_top_user_agents_response.py +10 -0
  184. gcore/types/waap/ip_info_list_attacked_countries_params.py +12 -0
  185. gcore/types/waap/ip_info_list_attacked_countries_response.py +10 -0
  186. gcore/types/waap/organization_list_params.py +22 -0
  187. gcore/types/waap/statistic_get_usage_series_params.py +25 -0
  188. gcore/types/waap/tag_list_params.py +28 -0
  189. gcore/types/waap/waap_advanced_rule.py +83 -0
  190. gcore/types/waap/waap_advanced_rule_descriptor.py +49 -0
  191. gcore/types/waap/waap_advanced_rule_descriptor_list.py +15 -0
  192. gcore/types/waap/waap_block_csrf_page_data.py +28 -0
  193. gcore/types/waap/waap_block_csrf_page_data_param.py +28 -0
  194. gcore/types/waap/waap_block_page_data.py +28 -0
  195. gcore/types/waap/waap_block_page_data_param.py +28 -0
  196. gcore/types/waap/waap_blocked_statistics.py +36 -0
  197. gcore/types/waap/waap_captcha_page_data.py +31 -0
  198. gcore/types/waap/waap_captcha_page_data_param.py +31 -0
  199. gcore/types/waap/waap_common_tag.py +16 -0
  200. gcore/types/waap/waap_cookie_disabled_page_data.py +18 -0
  201. gcore/types/waap/waap_cookie_disabled_page_data_param.py +18 -0
  202. gcore/types/waap/waap_count_statistics.py +36 -0
  203. gcore/types/waap/waap_custom_page_preview.py +10 -0
  204. gcore/types/waap/waap_custom_page_set.py +36 -0
  205. gcore/types/waap/waap_custom_rule.py +373 -0
  206. gcore/types/waap/waap_customer_rule_state.py +7 -0
  207. gcore/types/waap/waap_ddos_attack.py +16 -0
  208. gcore/types/waap/waap_ddos_info.py +17 -0
  209. gcore/types/waap/{waap_api_urls.py → waap_domain_api_settings.py} +9 -2
  210. gcore/types/waap/waap_domain_policy.py +29 -0
  211. gcore/types/waap/{waap_domain_settings.py → waap_domain_settings_model.py} +4 -4
  212. gcore/types/waap/waap_event_statistics.py +15 -0
  213. gcore/types/waap/waap_firewall_rule.py +78 -0
  214. gcore/types/waap/waap_get_account_overview_response.py +34 -0
  215. gcore/types/waap/waap_handshake_page_data.py +25 -0
  216. gcore/types/waap/waap_handshake_page_data_param.py +25 -0
  217. gcore/types/waap/waap_insight.py +38 -0
  218. gcore/types/waap/waap_insight_silence.py +28 -0
  219. gcore/types/waap/waap_insight_silence_sort_by.py +9 -0
  220. gcore/types/waap/waap_insight_sort_by.py +20 -0
  221. gcore/types/waap/waap_insight_status.py +7 -0
  222. gcore/types/waap/waap_ip_country_attack.py +16 -0
  223. gcore/types/waap/waap_ip_ddos_info_model.py +23 -0
  224. gcore/types/waap/waap_ip_info.py +57 -0
  225. gcore/types/waap/waap_ip_info_counts.py +16 -0
  226. gcore/types/waap/waap_javascript_disabled_page_data.py +18 -0
  227. gcore/types/waap/waap_javascript_disabled_page_data_param.py +18 -0
  228. gcore/types/waap/waap_network_details.py +17 -0
  229. gcore/types/waap/waap_organization.py +13 -0
  230. gcore/types/waap/waap_page_type.py +9 -0
  231. gcore/types/waap/waap_paginated_custom_page_set.py +22 -0
  232. gcore/types/waap/waap_paginated_ddos_attack.py +22 -0
  233. gcore/types/waap/waap_paginated_ddos_info.py +22 -0
  234. gcore/types/waap/waap_paginated_request_summary.py +22 -0
  235. gcore/types/waap/waap_pattern_matched_tag.py +37 -0
  236. gcore/types/waap/waap_policy_action.py +7 -0
  237. gcore/types/waap/waap_policy_mode.py +10 -0
  238. gcore/types/waap/waap_request_details.py +92 -0
  239. gcore/types/waap/waap_request_organization.py +13 -0
  240. gcore/types/waap/waap_request_summary.py +59 -0
  241. gcore/types/waap/waap_resolution.py +7 -0
  242. gcore/types/waap/waap_rule_action_type.py +7 -0
  243. gcore/types/waap/waap_rule_blocked_requests.py +16 -0
  244. gcore/types/waap/waap_rule_set.py +41 -0
  245. gcore/types/waap/waap_statistic_item.py +18 -0
  246. gcore/types/waap/waap_statistics_series.py +16 -0
  247. gcore/types/waap/waap_tag.py +16 -0
  248. gcore/types/waap/waap_time_series_attack.py +23 -0
  249. gcore/types/waap/waap_top_session.py +24 -0
  250. gcore/types/waap/waap_top_url.py +13 -0
  251. gcore/types/waap/waap_top_user_agent.py +13 -0
  252. gcore/types/waap/waap_traffic_metrics.py +68 -0
  253. gcore/types/waap/waap_traffic_type.py +28 -0
  254. gcore/types/waap/waap_user_agent_details.py +40 -0
  255. {gcore-0.2.0.dist-info → gcore-0.3.0.dist-info}/METADATA +1 -1
  256. {gcore-0.2.0.dist-info → gcore-0.3.0.dist-info}/RECORD +258 -109
  257. {gcore-0.2.0.dist-info → gcore-0.3.0.dist-info}/WHEEL +0 -0
  258. {gcore-0.2.0.dist-info → gcore-0.3.0.dist-info}/licenses/LICENSE +0 -0
@@ -139,18 +139,15 @@ class InstancesResource(SyncAPIResource):
139
139
  For Linux,
140
140
 
141
141
  - Use the `user_data` field to provide a
142
- <a href=https://cloudinit.readthedocs.io/en/latest/reference/examples.html>cloud-init
143
- script</a> in base64 to apply configurations to the instance.
142
+ [cloud-init script](https://cloudinit.readthedocs.io/en/latest/reference/examples.html)
143
+ in base64 to apply configurations to the instance.
144
144
  - Specify the `username` and `password` to create a new user.
145
145
  - When only `password` is provided, it is set as the password for the default
146
146
  user of the image.
147
- - The `user_data` is ignored when the `password` is specified.
148
-
149
- For Windows,
150
-
147
+ - The `user_data` is ignored when the `password` is specified. For Windows,
151
148
  - Use the `user_data` field to provide a
152
- <a href=https://cloudbase-init.readthedocs.io/en/latest/userdata.html#cloud-config>cloudbase-init
153
- script</a> in base64 to create new users on Windows.
149
+ [cloudbase-init script](https://cloudbase-init.readthedocs.io/en/latest/userdata.html#cloud-config)
150
+ in base64 to create new users on Windows.
154
151
  - Use the `password` field to set the password for the 'Admin' user on Windows.
155
152
  - The password of the Admin user cannot be updated via `user_data`.
156
153
  - The `username` cannot be specified in the request.
@@ -179,21 +176,20 @@ class InstancesResource(SyncAPIResource):
179
176
  name_template: If you want the instance name to be automatically generated based on IP
180
177
  addresses, you can provide a name template instead of specifying the name
181
178
  manually. The template should include a placeholder that will be replaced during
182
- provisioning. Supported placeholders are: `{ip_octets}` (last 3 octets of the
183
- IP), `{two_ip_octets}`, and `{one_ip_octet}`.
179
+ provisioning. Supported placeholders are: `{`ip_octets`}` (last 3 octets of the
180
+ IP), `{`two_ip_octets`}`, and `{`one_ip_octet`}`.
184
181
 
185
182
  password: For Linux instances, 'username' and 'password' are used to create a new user.
186
183
  When only 'password' is provided, it is set as the password for the default user
187
184
  of the image. For Windows instances, 'username' cannot be specified. Use the
188
185
  'password' field to set the password for the 'Admin' user on Windows. Use the
189
- 'user_data' field to provide a script to create new users on Windows. The
190
- password of the Admin user cannot be updated via 'user_data'.
186
+ '`user_data`' field to provide a script to create new users on Windows. The
187
+ password of the Admin user cannot be updated via '`user_data`'.
191
188
 
192
189
  security_groups: Specifies security group UUIDs to be applied to all instance network interfaces.
193
190
 
194
- servergroup_id: Placement group ID for instance placement policy.
195
-
196
- Supported group types:
191
+ servergroup_id:
192
+ Placement group ID for instance placement policy. Supported group types:
197
193
 
198
194
  - `anti-affinity`: Ensures instances are placed on different hosts for high
199
195
  availability.
@@ -202,7 +198,7 @@ class InstancesResource(SyncAPIResource):
202
198
  sharing if needed.
203
199
 
204
200
  ssh_key_name: Specifies the name of the SSH keypair, created via the
205
- <a href="#operation/SSHKeyCollectionViewSet.post">/v1/ssh_keys endpoint</a>.
201
+ [/v1/`ssh_keys` endpoint](/docs/api-reference/ssh-keys/add-or-generate-ssh-key).
206
202
 
207
203
  tags: Key-value tags to associate with the resource. A tag is a key-value pair that
208
204
  can be associated with a resource, enabling efficient filtering and grouping for
@@ -210,10 +206,10 @@ class InstancesResource(SyncAPIResource):
210
206
  modified by the user. Tags are also integrated with cost reports, allowing cost
211
207
  data to be filtered based on tag keys or values.
212
208
 
213
- user_data: String in base64 format. For Linux instances, 'user_data' is ignored when
209
+ user_data: String in base64 format. For Linux instances, '`user_data`' is ignored when
214
210
  'password' field is provided. For Windows instances, Admin user password is set
215
- by 'password' field and cannot be updated via 'user_data'. Examples of the
216
- user_data: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
211
+ by 'password' field and cannot be updated via '`user_data`'. Examples of the
212
+ `user_data`: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
217
213
 
218
214
  username: For Linux instances, 'username' and 'password' are used to create a new user.
219
215
  For Windows instances, 'username' cannot be specified. Use 'password' field to
@@ -452,9 +448,9 @@ class InstancesResource(SyncAPIResource):
452
448
 
453
449
  exclude_secgroup: Exclude instances with specified security group name
454
450
 
455
- flavor_id: Filter out instances by flavor_id. Flavor id must match exactly.
451
+ flavor_id: Filter out instances by `flavor_id`. Flavor id must match exactly.
456
452
 
457
- flavor_prefix: Filter out instances by flavor_prefix.
453
+ flavor_prefix: Filter out instances by `flavor_prefix`.
458
454
 
459
455
  include_ai: Include GPU clusters' servers
460
456
 
@@ -481,22 +477,22 @@ class InstancesResource(SyncAPIResource):
481
477
 
482
478
  order_by: Order by field and direction.
483
479
 
484
- profile_name: Filter result by ddos protection profile name. Effective only with with_ddos set
485
- to true.
480
+ profile_name: Filter result by ddos protection profile name. Effective only with `with_ddos`
481
+ set to true.
486
482
 
487
- protection_status: Filter result by DDoS protection_status. if parameter is provided. Effective
488
- only with with_ddos set to true. (Active, Queued or Error)
483
+ protection_status: Filter result by DDoS `protection_status`. if parameter is provided. Effective
484
+ only with `with_ddos` set to true. (Active, Queued or Error)
489
485
 
490
486
  status: Filters instances by status.
491
487
 
492
488
  tag_key_value: Optional. Filter by tag key-value pairs. curl -G --data-urlencode
493
- "tag_key_value={"key": "value"}" --url
489
+ "`tag_key_value`={"key": "value"}" --url
494
490
  "https://example.com/cloud/v1/resource/1/1"
495
491
 
496
- tag_value: Optional. Filter by tag values. ?tag_value=value1&tag_value=value2
492
+ tag_value: Optional. Filter by tag values. ?`tag_value`=value1&`tag_value`=value2
497
493
 
498
494
  type_ddos_profile: Return bare metals either only with advanced or only basic DDoS protection.
499
- Effective only with with_ddos set to true. (advanced or basic)
495
+ Effective only with `with_ddos` set to true. (advanced or basic)
500
496
 
501
497
  uuid: Filter the server list result by the UUID of the server. Allowed UUID part
502
498
 
@@ -691,7 +687,7 @@ class InstancesResource(SyncAPIResource):
691
687
  ) -> TaskIDList:
692
688
  """
693
689
  The action can be one of: start, stop, reboot, powercycle, suspend or resume.
694
- Suspend and resume are not available for baremetal instances.
690
+ Suspend and resume are not available for bare metal instances.
695
691
 
696
692
  Args:
697
693
  action: Instance action name
@@ -725,7 +721,7 @@ class InstancesResource(SyncAPIResource):
725
721
  ) -> TaskIDList:
726
722
  """
727
723
  The action can be one of: start, stop, reboot, powercycle, suspend or resume.
728
- Suspend and resume are not available for baremetal instances.
724
+ Suspend and resume are not available for bare metal instances.
729
725
 
730
726
  Args:
731
727
  action: Instance action name
@@ -884,7 +880,7 @@ class InstancesResource(SyncAPIResource):
884
880
  """Assign the security group to the server.
885
881
 
886
882
  To assign multiple security groups to
887
- all ports, use the NULL value for the port_id field
883
+ all ports, use the NULL value for the `port_id` field
888
884
 
889
885
  Args:
890
886
  name: Security group name, applies to all ports
@@ -1017,9 +1013,9 @@ class InstancesResource(SyncAPIResource):
1017
1013
 
1018
1014
  - `language` (str, optional): Language for the response content. Affects the
1019
1015
  `ddos_profile` field. Supported values:
1020
- - `'en'` (default)
1021
- - `'de'`
1022
- - `'ru'`
1016
+ - `'en'` (default)
1017
+ - `'de'`
1018
+ - `'ru'`
1023
1019
 
1024
1020
  Args:
1025
1021
  project_id: Project ID
@@ -1281,7 +1277,7 @@ class InstancesResource(SyncAPIResource):
1281
1277
  """Un-assign the security group to the server.
1282
1278
 
1283
1279
  To un-assign multiple security
1284
- groups to all ports, use the NULL value for the port_id field
1280
+ groups to all ports, use the NULL value for the `port_id` field
1285
1281
 
1286
1282
  Args:
1287
1283
  name: Security group name, applies to all ports
@@ -1385,18 +1381,15 @@ class AsyncInstancesResource(AsyncAPIResource):
1385
1381
  For Linux,
1386
1382
 
1387
1383
  - Use the `user_data` field to provide a
1388
- <a href=https://cloudinit.readthedocs.io/en/latest/reference/examples.html>cloud-init
1389
- script</a> in base64 to apply configurations to the instance.
1384
+ [cloud-init script](https://cloudinit.readthedocs.io/en/latest/reference/examples.html)
1385
+ in base64 to apply configurations to the instance.
1390
1386
  - Specify the `username` and `password` to create a new user.
1391
1387
  - When only `password` is provided, it is set as the password for the default
1392
1388
  user of the image.
1393
- - The `user_data` is ignored when the `password` is specified.
1394
-
1395
- For Windows,
1396
-
1389
+ - The `user_data` is ignored when the `password` is specified. For Windows,
1397
1390
  - Use the `user_data` field to provide a
1398
- <a href=https://cloudbase-init.readthedocs.io/en/latest/userdata.html#cloud-config>cloudbase-init
1399
- script</a> in base64 to create new users on Windows.
1391
+ [cloudbase-init script](https://cloudbase-init.readthedocs.io/en/latest/userdata.html#cloud-config)
1392
+ in base64 to create new users on Windows.
1400
1393
  - Use the `password` field to set the password for the 'Admin' user on Windows.
1401
1394
  - The password of the Admin user cannot be updated via `user_data`.
1402
1395
  - The `username` cannot be specified in the request.
@@ -1425,21 +1418,20 @@ class AsyncInstancesResource(AsyncAPIResource):
1425
1418
  name_template: If you want the instance name to be automatically generated based on IP
1426
1419
  addresses, you can provide a name template instead of specifying the name
1427
1420
  manually. The template should include a placeholder that will be replaced during
1428
- provisioning. Supported placeholders are: `{ip_octets}` (last 3 octets of the
1429
- IP), `{two_ip_octets}`, and `{one_ip_octet}`.
1421
+ provisioning. Supported placeholders are: `{`ip_octets`}` (last 3 octets of the
1422
+ IP), `{`two_ip_octets`}`, and `{`one_ip_octet`}`.
1430
1423
 
1431
1424
  password: For Linux instances, 'username' and 'password' are used to create a new user.
1432
1425
  When only 'password' is provided, it is set as the password for the default user
1433
1426
  of the image. For Windows instances, 'username' cannot be specified. Use the
1434
1427
  'password' field to set the password for the 'Admin' user on Windows. Use the
1435
- 'user_data' field to provide a script to create new users on Windows. The
1436
- password of the Admin user cannot be updated via 'user_data'.
1428
+ '`user_data`' field to provide a script to create new users on Windows. The
1429
+ password of the Admin user cannot be updated via '`user_data`'.
1437
1430
 
1438
1431
  security_groups: Specifies security group UUIDs to be applied to all instance network interfaces.
1439
1432
 
1440
- servergroup_id: Placement group ID for instance placement policy.
1441
-
1442
- Supported group types:
1433
+ servergroup_id:
1434
+ Placement group ID for instance placement policy. Supported group types:
1443
1435
 
1444
1436
  - `anti-affinity`: Ensures instances are placed on different hosts for high
1445
1437
  availability.
@@ -1448,7 +1440,7 @@ class AsyncInstancesResource(AsyncAPIResource):
1448
1440
  sharing if needed.
1449
1441
 
1450
1442
  ssh_key_name: Specifies the name of the SSH keypair, created via the
1451
- <a href="#operation/SSHKeyCollectionViewSet.post">/v1/ssh_keys endpoint</a>.
1443
+ [/v1/`ssh_keys` endpoint](/docs/api-reference/ssh-keys/add-or-generate-ssh-key).
1452
1444
 
1453
1445
  tags: Key-value tags to associate with the resource. A tag is a key-value pair that
1454
1446
  can be associated with a resource, enabling efficient filtering and grouping for
@@ -1456,10 +1448,10 @@ class AsyncInstancesResource(AsyncAPIResource):
1456
1448
  modified by the user. Tags are also integrated with cost reports, allowing cost
1457
1449
  data to be filtered based on tag keys or values.
1458
1450
 
1459
- user_data: String in base64 format. For Linux instances, 'user_data' is ignored when
1451
+ user_data: String in base64 format. For Linux instances, '`user_data`' is ignored when
1460
1452
  'password' field is provided. For Windows instances, Admin user password is set
1461
- by 'password' field and cannot be updated via 'user_data'. Examples of the
1462
- user_data: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
1453
+ by 'password' field and cannot be updated via '`user_data`'. Examples of the
1454
+ `user_data`: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
1463
1455
 
1464
1456
  username: For Linux instances, 'username' and 'password' are used to create a new user.
1465
1457
  For Windows instances, 'username' cannot be specified. Use 'password' field to
@@ -1698,9 +1690,9 @@ class AsyncInstancesResource(AsyncAPIResource):
1698
1690
 
1699
1691
  exclude_secgroup: Exclude instances with specified security group name
1700
1692
 
1701
- flavor_id: Filter out instances by flavor_id. Flavor id must match exactly.
1693
+ flavor_id: Filter out instances by `flavor_id`. Flavor id must match exactly.
1702
1694
 
1703
- flavor_prefix: Filter out instances by flavor_prefix.
1695
+ flavor_prefix: Filter out instances by `flavor_prefix`.
1704
1696
 
1705
1697
  include_ai: Include GPU clusters' servers
1706
1698
 
@@ -1727,22 +1719,22 @@ class AsyncInstancesResource(AsyncAPIResource):
1727
1719
 
1728
1720
  order_by: Order by field and direction.
1729
1721
 
1730
- profile_name: Filter result by ddos protection profile name. Effective only with with_ddos set
1731
- to true.
1722
+ profile_name: Filter result by ddos protection profile name. Effective only with `with_ddos`
1723
+ set to true.
1732
1724
 
1733
- protection_status: Filter result by DDoS protection_status. if parameter is provided. Effective
1734
- only with with_ddos set to true. (Active, Queued or Error)
1725
+ protection_status: Filter result by DDoS `protection_status`. if parameter is provided. Effective
1726
+ only with `with_ddos` set to true. (Active, Queued or Error)
1735
1727
 
1736
1728
  status: Filters instances by status.
1737
1729
 
1738
1730
  tag_key_value: Optional. Filter by tag key-value pairs. curl -G --data-urlencode
1739
- "tag_key_value={"key": "value"}" --url
1731
+ "`tag_key_value`={"key": "value"}" --url
1740
1732
  "https://example.com/cloud/v1/resource/1/1"
1741
1733
 
1742
- tag_value: Optional. Filter by tag values. ?tag_value=value1&tag_value=value2
1734
+ tag_value: Optional. Filter by tag values. ?`tag_value`=value1&`tag_value`=value2
1743
1735
 
1744
1736
  type_ddos_profile: Return bare metals either only with advanced or only basic DDoS protection.
1745
- Effective only with with_ddos set to true. (advanced or basic)
1737
+ Effective only with `with_ddos` set to true. (advanced or basic)
1746
1738
 
1747
1739
  uuid: Filter the server list result by the UUID of the server. Allowed UUID part
1748
1740
 
@@ -1937,7 +1929,7 @@ class AsyncInstancesResource(AsyncAPIResource):
1937
1929
  ) -> TaskIDList:
1938
1930
  """
1939
1931
  The action can be one of: start, stop, reboot, powercycle, suspend or resume.
1940
- Suspend and resume are not available for baremetal instances.
1932
+ Suspend and resume are not available for bare metal instances.
1941
1933
 
1942
1934
  Args:
1943
1935
  action: Instance action name
@@ -1971,7 +1963,7 @@ class AsyncInstancesResource(AsyncAPIResource):
1971
1963
  ) -> TaskIDList:
1972
1964
  """
1973
1965
  The action can be one of: start, stop, reboot, powercycle, suspend or resume.
1974
- Suspend and resume are not available for baremetal instances.
1966
+ Suspend and resume are not available for bare metal instances.
1975
1967
 
1976
1968
  Args:
1977
1969
  action: Instance action name
@@ -2130,7 +2122,7 @@ class AsyncInstancesResource(AsyncAPIResource):
2130
2122
  """Assign the security group to the server.
2131
2123
 
2132
2124
  To assign multiple security groups to
2133
- all ports, use the NULL value for the port_id field
2125
+ all ports, use the NULL value for the `port_id` field
2134
2126
 
2135
2127
  Args:
2136
2128
  name: Security group name, applies to all ports
@@ -2263,9 +2255,9 @@ class AsyncInstancesResource(AsyncAPIResource):
2263
2255
 
2264
2256
  - `language` (str, optional): Language for the response content. Affects the
2265
2257
  `ddos_profile` field. Supported values:
2266
- - `'en'` (default)
2267
- - `'de'`
2268
- - `'ru'`
2258
+ - `'en'` (default)
2259
+ - `'de'`
2260
+ - `'ru'`
2269
2261
 
2270
2262
  Args:
2271
2263
  project_id: Project ID
@@ -2527,7 +2519,7 @@ class AsyncInstancesResource(AsyncAPIResource):
2527
2519
  """Un-assign the security group to the server.
2528
2520
 
2529
2521
  To un-assign multiple security
2530
- groups to all ports, use the NULL value for the port_id field
2522
+ groups to all ports, use the NULL value for the `port_id` field
2531
2523
 
2532
2524
  Args:
2533
2525
  name: Security group name, applies to all ports
@@ -217,7 +217,7 @@ class InterfacesResource(SyncAPIResource):
217
217
 
218
218
  security_groups: List of security group IDs
219
219
 
220
- type: Must be 'any_subnet'
220
+ type: Must be '`any_subnet`'
221
221
 
222
222
  extra_headers: Send extra headers
223
223
 
@@ -264,7 +264,7 @@ class InterfacesResource(SyncAPIResource):
264
264
 
265
265
  security_groups: List of security group IDs
266
266
 
267
- type: Must be 'reserved_fixed_ip'. Union tag
267
+ type: Must be '`reserved_fixed_ip`'. Union tag
268
268
 
269
269
  extra_headers: Send extra headers
270
270
 
@@ -573,7 +573,7 @@ class AsyncInterfacesResource(AsyncAPIResource):
573
573
 
574
574
  security_groups: List of security group IDs
575
575
 
576
- type: Must be 'any_subnet'
576
+ type: Must be '`any_subnet`'
577
577
 
578
578
  extra_headers: Send extra headers
579
579
 
@@ -620,7 +620,7 @@ class AsyncInterfacesResource(AsyncAPIResource):
620
620
 
621
621
  security_groups: List of security group IDs
622
622
 
623
- type: Must be 'reserved_fixed_ip'. Union tag
623
+ type: Must be '`reserved_fixed_ip`'. Union tag
624
624
 
625
625
  extra_headers: Send extra headers
626
626
 
@@ -56,7 +56,7 @@ class FlavorsResource(SyncAPIResource):
56
56
  ) -> LoadBalancerFlavorList:
57
57
  """Retrieve a list of load balancer flavors.
58
58
 
59
- When the include_prices query
59
+ When the `include_prices` query
60
60
  parameter is specified, the list shows prices. A client in trial mode gets all
61
61
  price values as 0. If you get Pricing Error contact the support
62
62
 
@@ -123,7 +123,7 @@ class AsyncFlavorsResource(AsyncAPIResource):
123
123
  ) -> LoadBalancerFlavorList:
124
124
  """Retrieve a list of load balancer flavors.
125
125
 
126
- When the include_prices query
126
+ When the `include_prices` query
127
127
  parameter is specified, the list shows prices. A client in trial mode gets all
128
128
  price values as 0. If you get Pricing Error contact the support
129
129
 
@@ -92,17 +92,17 @@ class L7PoliciesResource(SyncAPIResource):
92
92
  position: The position of this policy on the listener. Positions start at 1.
93
93
 
94
94
  redirect_http_code: Requests matching this policy will be redirected to the specified URL or Prefix
95
- URL with the HTTP response code. Valid if action is REDIRECT_TO_URL or
96
- REDIRECT_PREFIX. Valid options are 301, 302, 303, 307, or 308. Default is 302.
95
+ URL with the HTTP response code. Valid if action is `REDIRECT_TO_URL` or
96
+ `REDIRECT_PREFIX`. Valid options are 301, 302, 303, 307, or 308. Default is 302.
97
97
 
98
98
  redirect_pool_id: Requests matching this policy will be redirected to the pool withthis ID. Only
99
- valid if action is REDIRECT_TO_POOL.
99
+ valid if action is `REDIRECT_TO_POOL`.
100
100
 
101
101
  redirect_prefix: Requests matching this policy will be redirected to this Prefix URL. Only valid
102
- if action is REDIRECT_PREFIX.
102
+ if action is `REDIRECT_PREFIX`.
103
103
 
104
104
  redirect_url: Requests matching this policy will be redirected to this URL. Only valid if
105
- action is REDIRECT_TO_URL.
105
+ action is `REDIRECT_TO_URL`.
106
106
 
107
107
  tags: A list of simple strings assigned to the resource.
108
108
 
@@ -286,17 +286,17 @@ class L7PoliciesResource(SyncAPIResource):
286
286
  position: The position of this policy on the listener. Positions start at 1.
287
287
 
288
288
  redirect_http_code: Requests matching this policy will be redirected to the specified URL or Prefix
289
- URL with the HTTP response code. Valid if action is REDIRECT_TO_URL or
290
- REDIRECT_PREFIX. Valid options are 301, 302, 303, 307, or 308. Default is 302.
289
+ URL with the HTTP response code. Valid if action is `REDIRECT_TO_URL` or
290
+ `REDIRECT_PREFIX`. Valid options are 301, 302, 303, 307, or 308. Default is 302.
291
291
 
292
292
  redirect_pool_id: Requests matching this policy will be redirected to the pool with this ID. Only
293
- valid if action is REDIRECT_TO_POOL.
293
+ valid if action is `REDIRECT_TO_POOL`.
294
294
 
295
295
  redirect_prefix: Requests matching this policy will be redirected to this Prefix URL. Only valid
296
- if action is REDIRECT_PREFIX.
296
+ if action is `REDIRECT_PREFIX`.
297
297
 
298
298
  redirect_url: Requests matching this policy will be redirected to this URL. Only valid if
299
- action is REDIRECT_TO_URL.
299
+ action is `REDIRECT_TO_URL`.
300
300
 
301
301
  tags: A list of simple strings assigned to the resource.
302
302
 
@@ -535,17 +535,17 @@ class AsyncL7PoliciesResource(AsyncAPIResource):
535
535
  position: The position of this policy on the listener. Positions start at 1.
536
536
 
537
537
  redirect_http_code: Requests matching this policy will be redirected to the specified URL or Prefix
538
- URL with the HTTP response code. Valid if action is REDIRECT_TO_URL or
539
- REDIRECT_PREFIX. Valid options are 301, 302, 303, 307, or 308. Default is 302.
538
+ URL with the HTTP response code. Valid if action is `REDIRECT_TO_URL` or
539
+ `REDIRECT_PREFIX`. Valid options are 301, 302, 303, 307, or 308. Default is 302.
540
540
 
541
541
  redirect_pool_id: Requests matching this policy will be redirected to the pool withthis ID. Only
542
- valid if action is REDIRECT_TO_POOL.
542
+ valid if action is `REDIRECT_TO_POOL`.
543
543
 
544
544
  redirect_prefix: Requests matching this policy will be redirected to this Prefix URL. Only valid
545
- if action is REDIRECT_PREFIX.
545
+ if action is `REDIRECT_PREFIX`.
546
546
 
547
547
  redirect_url: Requests matching this policy will be redirected to this URL. Only valid if
548
- action is REDIRECT_TO_URL.
548
+ action is `REDIRECT_TO_URL`.
549
549
 
550
550
  tags: A list of simple strings assigned to the resource.
551
551
 
@@ -729,17 +729,17 @@ class AsyncL7PoliciesResource(AsyncAPIResource):
729
729
  position: The position of this policy on the listener. Positions start at 1.
730
730
 
731
731
  redirect_http_code: Requests matching this policy will be redirected to the specified URL or Prefix
732
- URL with the HTTP response code. Valid if action is REDIRECT_TO_URL or
733
- REDIRECT_PREFIX. Valid options are 301, 302, 303, 307, or 308. Default is 302.
732
+ URL with the HTTP response code. Valid if action is `REDIRECT_TO_URL` or
733
+ `REDIRECT_PREFIX`. Valid options are 301, 302, 303, 307, or 308. Default is 302.
734
734
 
735
735
  redirect_pool_id: Requests matching this policy will be redirected to the pool with this ID. Only
736
- valid if action is REDIRECT_TO_POOL.
736
+ valid if action is `REDIRECT_TO_POOL`.
737
737
 
738
738
  redirect_prefix: Requests matching this policy will be redirected to this Prefix URL. Only valid
739
- if action is REDIRECT_PREFIX.
739
+ if action is `REDIRECT_PREFIX`.
740
740
 
741
741
  redirect_url: Requests matching this policy will be redirected to this URL. Only valid if
742
- action is REDIRECT_TO_URL.
742
+ action is `REDIRECT_TO_URL`.
743
743
 
744
744
  tags: A list of simple strings assigned to the resource.
745
745
 
@@ -98,13 +98,13 @@ class ListenersResource(SyncAPIResource):
98
98
  connection_limit: Limit of the simultaneous connections
99
99
 
100
100
  insert_x_forwarded: Add headers X-Forwarded-For, X-Forwarded-Port, X-Forwarded-Proto to requests.
101
- Only used with HTTP or TERMINATED_HTTPS protocols.
101
+ Only used with HTTP or `TERMINATED_HTTPS` protocols.
102
102
 
103
- secret_id: ID of the secret where PKCS12 file is stored for TERMINATED_HTTPS or PROMETHEUS
104
- listener
103
+ secret_id: ID of the secret where PKCS12 file is stored for `TERMINATED_HTTPS` or
104
+ PROMETHEUS listener
105
105
 
106
106
  sni_secret_id: List of secrets IDs containing PKCS12 format certificate/key bundles for
107
- TERMINATED_HTTPS or PROMETHEUS listeners
107
+ `TERMINATED_HTTPS` or PROMETHEUS listeners
108
108
 
109
109
  timeout_client_data: Frontend client inactivity timeout in milliseconds
110
110
 
@@ -190,11 +190,11 @@ class ListenersResource(SyncAPIResource):
190
190
 
191
191
  name: Load balancer listener name
192
192
 
193
- secret_id: ID of the secret where PKCS12 file is stored for TERMINATED_HTTPS or PROMETHEUS
194
- load balancer
193
+ secret_id: ID of the secret where PKCS12 file is stored for `TERMINATED_HTTPS` or
194
+ PROMETHEUS load balancer
195
195
 
196
196
  sni_secret_id: List of secret's ID containing PKCS12 format certificate/key bundfles for
197
- TERMINATED_HTTPS or PROMETHEUS listeners
197
+ `TERMINATED_HTTPS` or PROMETHEUS listeners
198
198
 
199
199
  timeout_client_data: Frontend client inactivity timeout in milliseconds
200
200
 
@@ -617,13 +617,13 @@ class AsyncListenersResource(AsyncAPIResource):
617
617
  connection_limit: Limit of the simultaneous connections
618
618
 
619
619
  insert_x_forwarded: Add headers X-Forwarded-For, X-Forwarded-Port, X-Forwarded-Proto to requests.
620
- Only used with HTTP or TERMINATED_HTTPS protocols.
620
+ Only used with HTTP or `TERMINATED_HTTPS` protocols.
621
621
 
622
- secret_id: ID of the secret where PKCS12 file is stored for TERMINATED_HTTPS or PROMETHEUS
623
- listener
622
+ secret_id: ID of the secret where PKCS12 file is stored for `TERMINATED_HTTPS` or
623
+ PROMETHEUS listener
624
624
 
625
625
  sni_secret_id: List of secrets IDs containing PKCS12 format certificate/key bundles for
626
- TERMINATED_HTTPS or PROMETHEUS listeners
626
+ `TERMINATED_HTTPS` or PROMETHEUS listeners
627
627
 
628
628
  timeout_client_data: Frontend client inactivity timeout in milliseconds
629
629
 
@@ -709,11 +709,11 @@ class AsyncListenersResource(AsyncAPIResource):
709
709
 
710
710
  name: Load balancer listener name
711
711
 
712
- secret_id: ID of the secret where PKCS12 file is stored for TERMINATED_HTTPS or PROMETHEUS
713
- load balancer
712
+ secret_id: ID of the secret where PKCS12 file is stored for `TERMINATED_HTTPS` or
713
+ PROMETHEUS load balancer
714
714
 
715
715
  sni_secret_id: List of secret's ID containing PKCS12 format certificate/key bundfles for
716
- TERMINATED_HTTPS or PROMETHEUS listeners
716
+ `TERMINATED_HTTPS` or PROMETHEUS listeners
717
717
 
718
718
  timeout_client_data: Frontend client inactivity timeout in milliseconds
719
719