platform-api-python-client 4.31.0__py3-none-any.whl → 4.41.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.
Files changed (200) hide show
  1. platform_api_python_client/__init__.py +410 -148
  2. platform_api_python_client/api/external_api.py +6466 -1215
  3. platform_api_python_client/api_client.py +81 -36
  4. platform_api_python_client/configuration.py +262 -66
  5. platform_api_python_client/exceptions.py +24 -5
  6. platform_api_python_client/models/__init__.py +90 -35
  7. platform_api_python_client/models/admission.py +106 -0
  8. platform_api_python_client/models/autoscaling.py +120 -0
  9. platform_api_python_client/models/ccl_dynamo_pools.py +117 -0
  10. platform_api_python_client/models/{create_c_serve_v2_deployment_response.py → ccl_main_pools.py} +16 -16
  11. platform_api_python_client/models/ccluster_catalogs_cluster_base_argo_rollouts_chart_values.py +121 -0
  12. platform_api_python_client/models/{c_serve_v2_recipe.py → ccluster_catalogs_cluster_base_argo_rollouts_controller.py} +15 -18
  13. platform_api_python_client/models/ccluster_catalogs_cluster_base_argo_rollouts_values.py +110 -0
  14. platform_api_python_client/models/ccluster_catalogs_cluster_base_cert_manager_chart_values.py +117 -0
  15. platform_api_python_client/models/ccluster_catalogs_cluster_base_cert_manager_values.py +110 -0
  16. platform_api_python_client/models/ccluster_catalogs_cluster_base_gpu_operator_chart_values.py +152 -0
  17. platform_api_python_client/models/ccluster_catalogs_cluster_base_gpu_operator_values.py +121 -0
  18. platform_api_python_client/models/ccluster_catalogs_cluster_base_ingress_nginx_chart_values.py +110 -0
  19. platform_api_python_client/models/ccluster_catalogs_cluster_base_ingress_nginx_controller.py +121 -0
  20. platform_api_python_client/models/ccluster_catalogs_cluster_base_ingress_nginx_values.py +110 -0
  21. platform_api_python_client/models/ccluster_catalogs_cluster_base_istio_values.py +143 -0
  22. platform_api_python_client/models/ccluster_catalogs_cluster_base_kai_scheduler_chart_values.py +154 -0
  23. platform_api_python_client/models/ccluster_catalogs_cluster_base_kai_scheduler_values.py +121 -0
  24. platform_api_python_client/models/ccluster_catalogs_cluster_base_keda_chart_values.py +131 -0
  25. platform_api_python_client/models/ccluster_catalogs_cluster_base_keda_values.py +110 -0
  26. platform_api_python_client/models/ccluster_catalogs_cluster_base_kube_prometheus_stack_chart_values.py +121 -0
  27. platform_api_python_client/models/ccluster_catalogs_cluster_base_kube_prometheus_stack_values.py +121 -0
  28. platform_api_python_client/models/ccluster_catalogs_cluster_base_metrics_server_chart_values.py +106 -0
  29. platform_api_python_client/models/ccluster_catalogs_cluster_base_metrics_server_values.py +110 -0
  30. platform_api_python_client/models/cdi.py +113 -0
  31. platform_api_python_client/models/cluster_base_components.py +187 -0
  32. platform_api_python_client/models/cluster_capacity_response.py +5 -5
  33. platform_api_python_client/models/cluster_credential.py +6 -5
  34. platform_api_python_client/models/cluster_registration_request.py +4 -3
  35. platform_api_python_client/models/cluster_registration_response.py +4 -3
  36. platform_api_python_client/models/{istio_cni_overrides.py → cni.py} +29 -15
  37. platform_api_python_client/models/config_file_mount.py +6 -5
  38. platform_api_python_client/models/create_compute_deployment_request.py +35 -9
  39. platform_api_python_client/models/create_compute_deployment_response.py +4 -3
  40. platform_api_python_client/models/create_dynamo_deployment_request.py +67 -20
  41. platform_api_python_client/models/create_dynamo_deployment_response.py +4 -3
  42. platform_api_python_client/models/create_filesystem_volume_request.py +8 -20
  43. platform_api_python_client/models/create_hardware_instance_request.py +4 -3
  44. platform_api_python_client/models/create_inference_deployment_response.py +4 -3
  45. platform_api_python_client/models/create_inference_v3_deployment_request.py +52 -10
  46. platform_api_python_client/models/create_job_deployment_request.py +35 -9
  47. platform_api_python_client/models/create_job_deployment_response.py +4 -3
  48. platform_api_python_client/models/create_object_volume_request.py +10 -22
  49. platform_api_python_client/models/create_organization_request.py +4 -3
  50. platform_api_python_client/models/create_organization_response.py +4 -3
  51. platform_api_python_client/models/create_service_account_request.py +4 -3
  52. platform_api_python_client/models/create_service_account_response.py +4 -3
  53. platform_api_python_client/models/credits_response.py +4 -3
  54. platform_api_python_client/models/daily_bill_response.py +4 -3
  55. platform_api_python_client/models/{fluent_bit.py → dashboard.py} +29 -12
  56. platform_api_python_client/models/{prometheus_adapter.py → default_priorities.py} +29 -12
  57. platform_api_python_client/models/default_queue.py +106 -0
  58. platform_api_python_client/models/delete_user_vault_item_request.py +4 -3
  59. platform_api_python_client/models/deployment_log_event_v4.py +4 -3
  60. platform_api_python_client/models/deployment_response.py +12 -27
  61. platform_api_python_client/models/deployment_status_request.py +4 -3
  62. platform_api_python_client/models/deployment_status_response.py +4 -3
  63. platform_api_python_client/models/deployment_status_v3_response.py +5 -5
  64. platform_api_python_client/models/deployment_type.py +14 -0
  65. platform_api_python_client/models/deployment_usage.py +5 -5
  66. platform_api_python_client/models/deployment_usage_value.py +4 -3
  67. platform_api_python_client/models/dynamo_communications_input.py +4 -16
  68. platform_api_python_client/models/dynamo_frontend_config.py +105 -0
  69. platform_api_python_client/models/dynamo_frontend_config_response.py +105 -0
  70. platform_api_python_client/models/dynamo_image.py +106 -0
  71. platform_api_python_client/models/dynamo_kv_transfer_configuration.py +4 -16
  72. platform_api_python_client/models/{external_dns.py → dynamo_weight_transfer_configuration.py} +13 -13
  73. platform_api_python_client/models/dynamo_weight_transfer_policy.py +36 -0
  74. platform_api_python_client/models/dynamo_worker_pool_config.py +6 -18
  75. platform_api_python_client/models/dynamo_worker_pools.py +4 -16
  76. platform_api_python_client/models/{keda.py → env.py} +14 -13
  77. platform_api_python_client/models/generate_service_account_secret_response.py +4 -3
  78. platform_api_python_client/models/get_cluster_response.py +8 -5
  79. platform_api_python_client/models/get_compute_deployment_response.py +35 -8
  80. platform_api_python_client/models/get_deployment_log_response.py +4 -3
  81. platform_api_python_client/models/get_deployment_log_v4_response.py +5 -5
  82. platform_api_python_client/models/get_deployment_pods_response.py +4 -3
  83. platform_api_python_client/models/get_deployment_response.py +7 -7
  84. platform_api_python_client/models/get_deployment_revision_response.py +4 -3
  85. platform_api_python_client/models/get_deployment_usage_response.py +24 -9
  86. platform_api_python_client/models/get_dynamo_deployment_response.py +63 -15
  87. platform_api_python_client/models/get_filesystem_volume_response.py +4 -3
  88. platform_api_python_client/models/get_inference_deployment_response.py +7 -7
  89. platform_api_python_client/models/get_inference_v3_deployment_response.py +51 -8
  90. platform_api_python_client/models/get_job_deployment_response.py +35 -8
  91. platform_api_python_client/models/get_object_volume_response.py +4 -3
  92. platform_api_python_client/models/gpu_type_capacity.py +4 -3
  93. platform_api_python_client/models/hardware_instance_response.py +10 -5
  94. platform_api_python_client/models/hardware_preset_response.py +4 -3
  95. platform_api_python_client/models/http_validation_error.py +5 -5
  96. platform_api_python_client/models/image.py +113 -0
  97. platform_api_python_client/models/image_pull_secret_credentials.py +4 -3
  98. platform_api_python_client/models/{istio_cni_subchart_overrides.py → ingress.py} +26 -18
  99. platform_api_python_client/models/{c_serve_recipe_response.py → insight_list_item_response.py} +33 -27
  100. platform_api_python_client/models/{create_c_serve_v3_deployment_response.py → insight_resource.py} +20 -14
  101. platform_api_python_client/models/insight_resource_type.py +37 -0
  102. platform_api_python_client/models/insight_response.py +133 -0
  103. platform_api_python_client/models/insight_severity.py +40 -0
  104. platform_api_python_client/models/insight_status.py +39 -0
  105. platform_api_python_client/models/insight_status_change_response.py +108 -0
  106. platform_api_python_client/models/invite_user_request.py +4 -3
  107. platform_api_python_client/models/istio_base.py +106 -0
  108. platform_api_python_client/models/istio_cni.py +124 -0
  109. platform_api_python_client/models/{ingress_nginx.py → istio_gateway.py} +29 -12
  110. platform_api_python_client/models/{dynamo_communications_output.py → istiod.py} +21 -15
  111. platform_api_python_client/models/list_cluster_capacity_response.py +5 -5
  112. platform_api_python_client/models/list_daily_bill_response.py +5 -5
  113. platform_api_python_client/models/list_deployment_revisions_response.py +5 -5
  114. platform_api_python_client/models/list_get_cluster_response.py +5 -5
  115. platform_api_python_client/models/list_get_deployment_response.py +5 -5
  116. platform_api_python_client/models/list_hardware_instance_response.py +5 -5
  117. platform_api_python_client/models/list_hardware_preset_response.py +5 -5
  118. platform_api_python_client/models/{istio_overrides.py → list_insights_response.py} +19 -20
  119. platform_api_python_client/models/list_organization_gpu_quota_response.py +5 -5
  120. platform_api_python_client/models/list_prebuilt_image_response.py +5 -5
  121. platform_api_python_client/models/list_service_accounts_response.py +5 -5
  122. platform_api_python_client/models/list_user_vault_items_response.py +5 -5
  123. platform_api_python_client/models/list_volumes_response.py +5 -5
  124. platform_api_python_client/models/{validation_error_loc_inner.py → location_inner.py} +6 -6
  125. platform_api_python_client/models/metric.py +13 -0
  126. platform_api_python_client/models/metrics.py +117 -0
  127. platform_api_python_client/models/metrics_config.py +6 -5
  128. platform_api_python_client/models/mig.py +106 -0
  129. platform_api_python_client/models/operator.py +117 -0
  130. platform_api_python_client/models/organization_gpu_quota_request.py +4 -3
  131. platform_api_python_client/models/organization_gpu_quota_response.py +4 -3
  132. platform_api_python_client/models/pilot.py +106 -0
  133. platform_api_python_client/models/pod_details.py +4 -3
  134. platform_api_python_client/models/pool.py +117 -0
  135. platform_api_python_client/models/prebuilt_image_response.py +4 -3
  136. platform_api_python_client/models/prometheus.py +110 -0
  137. platform_api_python_client/models/prometheus_rules.py +120 -0
  138. platform_api_python_client/models/prometheus_spec.py +113 -0
  139. platform_api_python_client/models/prometheus_values.py +117 -0
  140. platform_api_python_client/models/quota.py +106 -0
  141. platform_api_python_client/models/replicas.py +106 -0
  142. platform_api_python_client/models/resource_list.py +113 -0
  143. platform_api_python_client/models/resource_requirements.py +120 -0
  144. platform_api_python_client/models/revision_pod_details.py +5 -5
  145. platform_api_python_client/models/rollout_strategy_params.py +4 -3
  146. platform_api_python_client/models/scheduler.py +117 -0
  147. platform_api_python_client/models/service_account_response.py +4 -3
  148. platform_api_python_client/models/{istio.py → toggle.py} +27 -19
  149. platform_api_python_client/models/toleration.py +134 -0
  150. platform_api_python_client/models/unified_get_compute_deployment_response.py +177 -0
  151. platform_api_python_client/models/{c_serve_recipe_perf.py → unified_get_deployment_logs_response.py} +19 -22
  152. platform_api_python_client/models/{longhorn.py → unified_get_deployment_pods_response.py} +13 -14
  153. platform_api_python_client/models/unified_get_deployment_response.py +164 -0
  154. platform_api_python_client/models/unified_get_deployment_revision_response.py +110 -0
  155. platform_api_python_client/models/{argo_rollouts.py → unified_get_deployment_rollout_response.py} +15 -13
  156. platform_api_python_client/models/unified_get_deployment_usage_response.py +110 -0
  157. platform_api_python_client/models/unified_get_dynamo_deployment_response.py +218 -0
  158. platform_api_python_client/models/unified_get_inference_v3_deployment_response.py +228 -0
  159. platform_api_python_client/models/unified_get_job_deployment_response.py +204 -0
  160. platform_api_python_client/models/{list_c_serve_recipe_response.py → unified_list_deployment_revisions_response.py} +12 -12
  161. platform_api_python_client/models/{spire.py → unified_update_deployment_rollout_request.py} +12 -13
  162. platform_api_python_client/models/unified_write_compute_deployment_request.py +154 -0
  163. platform_api_python_client/models/unified_write_deployment_request.py +164 -0
  164. platform_api_python_client/models/unified_write_deployment_response.py +110 -0
  165. platform_api_python_client/models/unified_write_dynamo_deployment_request.py +197 -0
  166. platform_api_python_client/models/{create_c_serve_v3_deployment_request.py → unified_write_inference_v3_deployment_request.py} +86 -78
  167. platform_api_python_client/models/unified_write_job_deployment_request.py +183 -0
  168. platform_api_python_client/models/update_cluster_metadata_request.py +4 -3
  169. platform_api_python_client/models/{cluster_config.py → update_cluster_request.py} +11 -10
  170. platform_api_python_client/models/update_deployment_response.py +4 -3
  171. platform_api_python_client/models/update_deployment_status_v3_request.py +4 -3
  172. platform_api_python_client/models/update_insight_status_request.py +107 -0
  173. platform_api_python_client/models/update_service_account_request.py +4 -3
  174. platform_api_python_client/models/upsert_user_vault_item_request.py +5 -4
  175. platform_api_python_client/models/usage_availability.py +40 -0
  176. platform_api_python_client/models/usage_component.py +39 -0
  177. platform_api_python_client/models/user_vault_item.py +4 -3
  178. platform_api_python_client/models/validation_error.py +8 -8
  179. platform_api_python_client/models/volume_mount.py +4 -3
  180. platform_api_python_client/models/volume_status_response.py +4 -3
  181. platform_api_python_client/models/workload.py +110 -0
  182. platform_api_python_client/rest.py +87 -10
  183. platform_api_python_client-4.41.0.dist-info/METADATA +418 -0
  184. platform_api_python_client-4.41.0.dist-info/RECORD +206 -0
  185. {platform_api_python_client-4.31.0.dist-info → platform_api_python_client-4.41.0.dist-info}/WHEEL +1 -1
  186. platform_api_python_client/models/cert_manager.py +0 -89
  187. platform_api_python_client/models/cluster_components.py +0 -193
  188. platform_api_python_client/models/final_stack.py +0 -89
  189. platform_api_python_client/models/get_c_serve_v2_deployment_response.py +0 -193
  190. platform_api_python_client/models/get_c_serve_v3_deployment_response.py +0 -194
  191. platform_api_python_client/models/gpu_operator.py +0 -89
  192. platform_api_python_client/models/kube_prometheus_stack.py +0 -89
  193. platform_api_python_client/models/metrics_server.py +0 -89
  194. platform_api_python_client/models/network_operator.py +0 -89
  195. platform_api_python_client/models/opentelemetry_collector.py +0 -89
  196. platform_api_python_client/models/spire_crds.py +0 -89
  197. platform_api_python_client/models/teleport_kube_agent.py +0 -89
  198. platform_api_python_client-4.31.0.dist-info/METADATA +0 -23
  199. platform_api_python_client-4.31.0.dist-info/RECORD +0 -151
  200. {platform_api_python_client-4.31.0.dist-info → platform_api_python_client-4.41.0.dist-info}/top_level.txt +0 -0
@@ -12,10 +12,12 @@
12
12
  """ # noqa: E501
13
13
 
14
14
 
15
+ import ipaddress
15
16
  import io
16
17
  import json
17
18
  import re
18
19
  import ssl
20
+ from urllib.parse import urlparse
19
21
 
20
22
  import urllib3
21
23
 
@@ -34,6 +36,59 @@ def is_socks_proxy_url(url):
34
36
  else:
35
37
  return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES
36
38
 
39
+ def contenttype_matches(contenttype, maintype, subtype):
40
+ """Matches the given contenttype against the given type and subtype
41
+
42
+ :param contenttype: the content type to match
43
+ :param maintype: the expected maintype
44
+ :param subtype: the expected subtype
45
+ :return: `true` when the given content type matches the given type and subtype,
46
+ regardless of the presence of mime type parameters, otherwise returns `false`.
47
+ :rtype: bool
48
+ """
49
+ pattern = '{type}/(?:[^+;]+\\+)?{subtype}(?:[ \t]*;.*)?'.format(
50
+ type = re.escape(maintype),
51
+ subtype = re.escape(subtype),
52
+ )
53
+ return re.fullmatch(pattern, contenttype, re.IGNORECASE) is not None
54
+
55
+ def should_bypass_proxies(url: str, no_proxy: str) -> bool:
56
+ """Return whether ``url`` matches the comma-separated ``no_proxy`` rules."""
57
+ parsed_url = urlparse(url)
58
+ if not parsed_url.hostname:
59
+ return True
60
+
61
+ host = parsed_url.hostname.lower()
62
+ host_and_port = parsed_url.netloc.lower()
63
+ try:
64
+ host_ip = ipaddress.ip_address(host)
65
+ except ValueError:
66
+ host_ip = None
67
+
68
+ for entry in (entry.strip().lower() for entry in no_proxy.split(',')):
69
+ if not entry:
70
+ continue
71
+ if entry == '*':
72
+ return True
73
+
74
+ if host_ip is not None:
75
+ try:
76
+ if host_ip in ipaddress.ip_network(entry, strict=False):
77
+ return True
78
+ except ValueError:
79
+ pass
80
+
81
+ entry = entry.lstrip('.')
82
+ if (
83
+ host == entry
84
+ or host.endswith('.' + entry)
85
+ or host_and_port == entry
86
+ or host_and_port.endswith('.' + entry)
87
+ ):
88
+ return True
89
+
90
+ return False
91
+
37
92
 
38
93
  class RESTResponse(io.IOBase):
39
94
 
@@ -48,12 +103,17 @@ class RESTResponse(io.IOBase):
48
103
  self.data = self.response.data
49
104
  return self.data
50
105
 
106
+ @property
107
+ def headers(self):
108
+ """Returns a dictionary of response headers."""
109
+ return self.response.headers
110
+
51
111
  def getheaders(self):
52
- """Returns a dictionary of the response headers."""
112
+ """Returns a dictionary of the response headers; use ``headers`` instead."""
53
113
  return self.response.headers
54
114
 
55
115
  def getheader(self, name, default=None):
56
- """Returns a given response header."""
116
+ """Returns a given response header; use ``headers.get()`` instead."""
57
117
  return self.response.headers.get(name, default)
58
118
 
59
119
 
@@ -76,6 +136,7 @@ class RESTClientObject:
76
136
  "ca_certs": configuration.ssl_ca_cert,
77
137
  "cert_file": configuration.cert_file,
78
138
  "key_file": configuration.key_file,
139
+ "ca_cert_data": configuration.ca_cert_data,
79
140
  }
80
141
  if configuration.assert_hostname is not None:
81
142
  pool_args['assert_hostname'] = (
@@ -98,7 +159,9 @@ class RESTClientObject:
98
159
  # https pool manager
99
160
  self.pool_manager: urllib3.PoolManager
100
161
 
101
- if configuration.proxy:
162
+ if configuration.proxy and not should_bypass_proxies(
163
+ configuration.host, configuration.no_proxy or ''
164
+ ):
102
165
  if is_socks_proxy_url(configuration.proxy):
103
166
  from urllib3.contrib.socks import SOCKSProxyManager
104
167
  pool_args["proxy_url"] = configuration.proxy
@@ -107,6 +170,8 @@ class RESTClientObject:
107
170
  else:
108
171
  pool_args["proxy_url"] = configuration.proxy
109
172
  pool_args["proxy_headers"] = configuration.proxy_headers
173
+ if configuration.proxy_ssl_context is not None:
174
+ pool_args["proxy_ssl_context"] = configuration.proxy_ssl_context
110
175
  self.pool_manager = urllib3.ProxyManager(**pool_args)
111
176
  else:
112
177
  self.pool_manager = urllib3.PoolManager(**pool_args)
@@ -170,12 +235,24 @@ class RESTClientObject:
170
235
  # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
171
236
  if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
172
237
 
173
- # no content type provided or payload is json
174
238
  content_type = headers.get('Content-Type')
175
- if (
239
+ is_json = (
176
240
  not content_type
177
- or re.search('json', content_type, re.IGNORECASE)
178
- ):
241
+ or contenttype_matches(content_type, 'application', 'json')
242
+ )
243
+ # JSON is valid YAML 1.2, so structured YAML bodies can use
244
+ # the existing JSON serializer:
245
+ # https://yaml.org/spec/1.2.2/#13-relation-to-json
246
+ is_structured_yaml = (
247
+ content_type
248
+ and (
249
+ contenttype_matches(content_type, 'application', 'yaml')
250
+ or contenttype_matches(content_type, 'text', 'yaml')
251
+ or contenttype_matches(content_type, 'text', 'x-yaml')
252
+ )
253
+ and not isinstance(body, (str, bytes))
254
+ )
255
+ if is_json or is_structured_yaml:
179
256
  request_body = None
180
257
  if body is not None:
181
258
  request_body = json.dumps(body)
@@ -187,7 +264,7 @@ class RESTClientObject:
187
264
  headers=headers,
188
265
  preload_content=False
189
266
  )
190
- elif content_type == 'application/x-www-form-urlencoded':
267
+ elif contenttype_matches(content_type, 'application', 'x-www-form-urlencoded'):
191
268
  r = self.pool_manager.request(
192
269
  method,
193
270
  url,
@@ -197,7 +274,7 @@ class RESTClientObject:
197
274
  headers=headers,
198
275
  preload_content=False
199
276
  )
200
- elif content_type == 'multipart/form-data':
277
+ elif contenttype_matches(content_type, 'multipart', 'form-data'):
201
278
  # must del headers['Content-Type'], or the correct
202
279
  # Content-Type which generated by urllib3 will be
203
280
  # overwritten.
@@ -225,7 +302,7 @@ class RESTClientObject:
225
302
  headers=headers,
226
303
  preload_content=False
227
304
  )
228
- elif headers['Content-Type'].startswith('text/') and isinstance(body, bool):
305
+ elif content_type.startswith('text/') and isinstance(body, bool):
229
306
  request_body = "true" if body else "false"
230
307
  r = self.pool_manager.request(
231
308
  method,
@@ -0,0 +1,418 @@
1
+ Metadata-Version: 2.4
2
+ Name: platform_api_python_client
3
+ Version: 4.41.0
4
+ Summary: Platform External API
5
+ Home-page:
6
+ Author: OpenAPI Generator community
7
+ Author-email: OpenAPI Generator Community <team@openapitools.org>
8
+ Project-URL: Repository, https://github.com/centml/platform/client
9
+ Keywords: OpenAPI,OpenAPI-Generator,Platform External API
10
+ Requires-Python: >=3.10
11
+ Description-Content-Type: text/markdown
12
+ Requires-Dist: urllib3<3.0.0,>=2.7.0
13
+ Requires-Dist: python-dateutil>=2.8.2
14
+ Requires-Dist: pydantic>=2.11
15
+ Requires-Dist: typing-extensions>=4.7.1
16
+ Dynamic: author
17
+
18
+ # platform-api-python-client
19
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
20
+
21
+ This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
22
+
23
+ - API version: 0.1.0
24
+ - Package version: 4.41.0
25
+ - Generator version: 7.26.0
26
+ - Build package: org.openapitools.codegen.languages.PythonClientCodegen
27
+
28
+ ## Requirements.
29
+
30
+ Python 3.10+
31
+
32
+ Packaging uses standard `[project]` metadata and `[dependency-groups]` (PEP 621/735).
33
+ Install the package with `python -m pip install .`; install development dependencies
34
+ with Poetry 2.2 or newer using `poetry install`, or pip 25.1 or newer using
35
+ `python -m pip install --group dev`. The latter installs the group, not the package.
36
+
37
+ ## Installation & Usage
38
+ ### pip install
39
+
40
+ If the python package is hosted on a repository, you can install directly using:
41
+
42
+ ```sh
43
+ pip install git+https://github.com/centml/platform/client.git
44
+ ```
45
+ (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/centml/platform/client.git`)
46
+
47
+ Then import the package:
48
+ ```python
49
+ import platform_api_python_client
50
+ ```
51
+
52
+ ### Setuptools
53
+
54
+ Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
55
+
56
+ ```sh
57
+ python setup.py install --user
58
+ ```
59
+ (or `sudo python setup.py install` to install the package for all users)
60
+
61
+ Then import the package:
62
+ ```python
63
+ import platform_api_python_client
64
+ ```
65
+
66
+ ### Tests
67
+
68
+ Execute `pytest` to run the tests.
69
+
70
+ ## Getting Started
71
+
72
+ Please follow the [installation procedure](#installation--usage) and then run the following:
73
+
74
+ ```python
75
+
76
+ import platform_api_python_client
77
+ from platform_api_python_client.rest import ApiException
78
+ from pprint import pprint
79
+
80
+ # Defining the host is optional and defaults to http://localhost
81
+ # See configuration.py for a list of all supported configuration parameters.
82
+ configuration = platform_api_python_client.Configuration(
83
+ host = "http://localhost"
84
+ )
85
+
86
+ # The client must configure the authentication and authorization parameters
87
+ # in accordance with the API server security policy.
88
+ # Examples for each auth method are provided below, use the example that
89
+ # satisfies your auth use case.
90
+
91
+ # Configure Bearer authorization: HTTPBearer
92
+ configuration = platform_api_python_client.Configuration(
93
+ access_token = os.environ["BEARER_TOKEN"]
94
+ )
95
+
96
+
97
+ # Enter a context with an instance of the API client
98
+ with platform_api_python_client.ApiClient(configuration) as api_client:
99
+ # Create an instance of the API class
100
+ api_instance = platform_api_python_client.EXTERNALApi(api_client)
101
+ cluster_registration_request = platform_api_python_client.ClusterRegistrationRequest() # ClusterRegistrationRequest |
102
+
103
+ try:
104
+ # Create Cluster
105
+ api_response = api_instance.create_cluster_clusters_post(cluster_registration_request)
106
+ print("The response of EXTERNALApi->create_cluster_clusters_post:\n")
107
+ pprint(api_response)
108
+ except ApiException as e:
109
+ print("Exception when calling EXTERNALApi->create_cluster_clusters_post: %s\n" % e)
110
+
111
+ ```
112
+
113
+ ## Documentation for API Endpoints
114
+
115
+ All URIs are relative to *http://localhost*
116
+
117
+ Class | Method | HTTP request | Description
118
+ ------------ | ------------- | ------------- | -------------
119
+ *EXTERNALApi* | [**create_cluster_clusters_post**](docs/EXTERNALApi.md#create_cluster_clusters_post) | **POST** /clusters | Create Cluster
120
+ *EXTERNALApi* | [**create_compute_deployment_deployments_compute_post**](docs/EXTERNALApi.md#create_compute_deployment_deployments_compute_post) | **POST** /deployments/compute | Create Compute Deployment
121
+ *EXTERNALApi* | [**create_cserve_deployment_deployments_cserve_post**](docs/EXTERNALApi.md#create_cserve_deployment_deployments_cserve_post) | **POST** /deployments/cserve | Retired Cserve Deployment
122
+ *EXTERNALApi* | [**create_cserve_v2_deployment_deployments_cserve_v2_post**](docs/EXTERNALApi.md#create_cserve_v2_deployment_deployments_cserve_v2_post) | **POST** /deployments/cserve_v2 | Retired Cserve Deployment
123
+ *EXTERNALApi* | [**create_cserve_v3_deployment_deployments_cserve_v3_post**](docs/EXTERNALApi.md#create_cserve_v3_deployment_deployments_cserve_v3_post) | **POST** /deployments/cserve_v3 | Retired Cserve Deployment
124
+ *EXTERNALApi* | [**create_dynamo_deployment_deployments_dynamo_post**](docs/EXTERNALApi.md#create_dynamo_deployment_deployments_dynamo_post) | **POST** /deployments/dynamo | Create Dynamo Deployment
125
+ *EXTERNALApi* | [**create_hardware_instance_hardware_instances_post**](docs/EXTERNALApi.md#create_hardware_instance_hardware_instances_post) | **POST** /hardware-instances | Create Hardware Instance
126
+ *EXTERNALApi* | [**create_inference_deployment_deployments_inference_post**](docs/EXTERNALApi.md#create_inference_deployment_deployments_inference_post) | **POST** /deployments/inference | Create Inference Deployment
127
+ *EXTERNALApi* | [**create_inference_v3_deployment_deployments_inference_v3_post**](docs/EXTERNALApi.md#create_inference_v3_deployment_deployments_inference_v3_post) | **POST** /deployments/inference_v3 | Create Inference V3 Deployment
128
+ *EXTERNALApi* | [**create_job_deployment_deployments_job_post**](docs/EXTERNALApi.md#create_job_deployment_deployments_job_post) | **POST** /deployments/job | Create Job Deployment
129
+ *EXTERNALApi* | [**create_new_organization_organizations_post**](docs/EXTERNALApi.md#create_new_organization_organizations_post) | **POST** /organizations | Create New Organization
130
+ *EXTERNALApi* | [**create_service_account_service_accounts_post**](docs/EXTERNALApi.md#create_service_account_service_accounts_post) | **POST** /service-accounts | Create Service Account
131
+ *EXTERNALApi* | [**create_unified_deployment_deployments_post**](docs/EXTERNALApi.md#create_unified_deployment_deployments_post) | **POST** /deployments | Create Unified Deployment
132
+ *EXTERNALApi* | [**create_volume_endpoint_volumes_post**](docs/EXTERNALApi.md#create_volume_endpoint_volumes_post) | **POST** /volumes | Create Volume Endpoint
133
+ *EXTERNALApi* | [**delete_cluster_clusters_cluster_id_delete**](docs/EXTERNALApi.md#delete_cluster_clusters_cluster_id_delete) | **DELETE** /clusters/{cluster_id} | Delete Cluster
134
+ *EXTERNALApi* | [**delete_hardware_instance_hardware_instances_hardware_instance_id_delete**](docs/EXTERNALApi.md#delete_hardware_instance_hardware_instances_hardware_instance_id_delete) | **DELETE** /hardware-instances/{hardware_instance_id} | Delete Hardware Instance
135
+ *EXTERNALApi* | [**delete_service_account_service_accounts_workos_id_delete**](docs/EXTERNALApi.md#delete_service_account_service_accounts_workos_id_delete) | **DELETE** /service-accounts/{workos_id} | Delete Service Account
136
+ *EXTERNALApi* | [**delete_unified_deployment_deployments_deployment_id_delete**](docs/EXTERNALApi.md#delete_unified_deployment_deployments_deployment_id_delete) | **DELETE** /deployments/{deployment_id} | Delete Unified Deployment
137
+ *EXTERNALApi* | [**delete_user_vault_item_by_id_endpoint_user_vault_secret_id_delete**](docs/EXTERNALApi.md#delete_user_vault_item_by_id_endpoint_user_vault_secret_id_delete) | **DELETE** /user_vault/{secret_id} | Delete User Vault Item By Id Endpoint
138
+ *EXTERNALApi* | [**delete_user_vault_item_endpoint_user_vault_delete**](docs/EXTERNALApi.md#delete_user_vault_item_endpoint_user_vault_delete) | **DELETE** /user_vault | Delete User Vault Item Endpoint
139
+ *EXTERNALApi* | [**delete_volume_endpoint_volumes_volume_id_delete**](docs/EXTERNALApi.md#delete_volume_endpoint_volumes_volume_id_delete) | **DELETE** /volumes/{volume_id} | Delete Volume Endpoint
140
+ *EXTERNALApi* | [**generate_service_account_secret_service_accounts_workos_id_secrets_post**](docs/EXTERNALApi.md#generate_service_account_secret_service_accounts_workos_id_secrets_post) | **POST** /service-accounts/{workos_id}/secrets | Generate Service Account Secret
141
+ *EXTERNALApi* | [**get_all_user_vault_items_endpoint_user_vault_get**](docs/EXTERNALApi.md#get_all_user_vault_items_endpoint_user_vault_get) | **GET** /user_vault | Get All User Vault Items Endpoint
142
+ *EXTERNALApi* | [**get_all_volumes_endpoint_volumes_get**](docs/EXTERNALApi.md#get_all_volumes_endpoint_volumes_get) | **GET** /volumes | Get All Volumes Endpoint
143
+ *EXTERNALApi* | [**get_clusters_clusters_get**](docs/EXTERNALApi.md#get_clusters_clusters_get) | **GET** /clusters | Get Clusters
144
+ *EXTERNALApi* | [**get_compute_deployment_deployments_compute_deployment_id_get**](docs/EXTERNALApi.md#get_compute_deployment_deployments_compute_deployment_id_get) | **GET** /deployments/compute/{deployment_id} | Get Compute Deployment
145
+ *EXTERNALApi* | [**get_credits_credits_get**](docs/EXTERNALApi.md#get_credits_credits_get) | **GET** /credits | Get Credits
146
+ *EXTERNALApi* | [**get_cserve_deployment_deployments_cserve_deployment_id_get**](docs/EXTERNALApi.md#get_cserve_deployment_deployments_cserve_deployment_id_get) | **GET** /deployments/cserve/{deployment_id} | Retired Cserve Deployment Detail
147
+ *EXTERNALApi* | [**get_cserve_v2_deployment_deployments_cserve_v2_deployment_id_get**](docs/EXTERNALApi.md#get_cserve_v2_deployment_deployments_cserve_v2_deployment_id_get) | **GET** /deployments/cserve_v2/{deployment_id} | Retired Cserve Deployment Detail
148
+ *EXTERNALApi* | [**get_cserve_v3_deployment_deployments_cserve_v3_deployment_id_get**](docs/EXTERNALApi.md#get_cserve_v3_deployment_deployments_cserve_v3_deployment_id_get) | **GET** /deployments/cserve_v3/{deployment_id} | Retired Cserve Deployment Detail
149
+ *EXTERNALApi* | [**get_current_org_gpu_quota_organizations_gpu_quota_get**](docs/EXTERNALApi.md#get_current_org_gpu_quota_organizations_gpu_quota_get) | **GET** /organizations/gpu-quota | Get Current Org Gpu Quota
150
+ *EXTERNALApi* | [**get_deployment_logs_deployments_logs_deployment_id_get**](docs/EXTERNALApi.md#get_deployment_logs_deployments_logs_deployment_id_get) | **GET** /deployments/logs/{deployment_id} | Get Deployment Logs
151
+ *EXTERNALApi* | [**get_deployment_logs_v3_deployments_logs_v3_deployment_id_revision_number_get**](docs/EXTERNALApi.md#get_deployment_logs_v3_deployments_logs_v3_deployment_id_revision_number_get) | **GET** /deployments/logs_v3/{deployment_id}/{revision_number} | Get Deployment Logs V3
152
+ *EXTERNALApi* | [**get_deployment_logs_v4_logs_deployment_id_revision_number_get**](docs/EXTERNALApi.md#get_deployment_logs_v4_logs_deployment_id_revision_number_get) | **GET** /logs/{deployment_id}/{revision_number} | Get Deployment Logs V4
153
+ *EXTERNALApi* | [**get_deployment_pods_deployments_pods_deployment_id_revision_number_get**](docs/EXTERNALApi.md#get_deployment_pods_deployments_pods_deployment_id_revision_number_get) | **GET** /deployments/pods/{deployment_id}/{revision_number} | Get Deployment Pods
154
+ *EXTERNALApi* | [**get_deployment_revision_deployments_revisions_deployment_id_revision_number_get**](docs/EXTERNALApi.md#get_deployment_revision_deployments_revisions_deployment_id_revision_number_get) | **GET** /deployments/revisions/{deployment_id}/{revision_number} | Get Deployment Revision
155
+ *EXTERNALApi* | [**get_deployment_revisions_deployments_revisions_deployment_id_get**](docs/EXTERNALApi.md#get_deployment_revisions_deployments_revisions_deployment_id_get) | **GET** /deployments/revisions/{deployment_id} | Get Deployment Revisions
156
+ *EXTERNALApi* | [**get_deployment_status_deployments_status_deployment_id_get**](docs/EXTERNALApi.md#get_deployment_status_deployments_status_deployment_id_get) | **GET** /deployments/status/{deployment_id} | Get Deployment Status
157
+ *EXTERNALApi* | [**get_deployment_status_v3_deployments_status_v3_deployment_id_get**](docs/EXTERNALApi.md#get_deployment_status_v3_deployments_status_v3_deployment_id_get) | **GET** /deployments/status_v3/{deployment_id} | Get Deployment Status V3
158
+ *EXTERNALApi* | [**get_deployments_deployments_get**](docs/EXTERNALApi.md#get_deployments_deployments_get) | **GET** /deployments | Get Deployments
159
+ *EXTERNALApi* | [**get_dynamo_deployment_deployments_dynamo_deployment_id_get**](docs/EXTERNALApi.md#get_dynamo_deployment_deployments_dynamo_deployment_id_get) | **GET** /deployments/dynamo/{deployment_id} | Get Dynamo Deployment
160
+ *EXTERNALApi* | [**get_hardware_instances_hardware_instances_get**](docs/EXTERNALApi.md#get_hardware_instances_hardware_instances_get) | **GET** /hardware-instances | Get Hardware Instances
161
+ *EXTERNALApi* | [**get_hardware_presets_hardware_instances_presets_get**](docs/EXTERNALApi.md#get_hardware_presets_hardware_instances_presets_get) | **GET** /hardware-instances/presets | Get Hardware Presets
162
+ *EXTERNALApi* | [**get_inference_deployment_deployments_inference_deployment_id_get**](docs/EXTERNALApi.md#get_inference_deployment_deployments_inference_deployment_id_get) | **GET** /deployments/inference/{deployment_id} | Get Inference Deployment
163
+ *EXTERNALApi* | [**get_inference_v3_deployment_deployments_inference_v3_deployment_id_get**](docs/EXTERNALApi.md#get_inference_v3_deployment_deployments_inference_v3_deployment_id_get) | **GET** /deployments/inference_v3/{deployment_id} | Get Inference V3 Deployment
164
+ *EXTERNALApi* | [**get_insight_insights_insight_id_get**](docs/EXTERNALApi.md#get_insight_insights_insight_id_get) | **GET** /insights/{insight_id} | Get Insight
165
+ *EXTERNALApi* | [**get_job_deployment_deployments_job_deployment_id_get**](docs/EXTERNALApi.md#get_job_deployment_deployments_job_deployment_id_get) | **GET** /deployments/job/{deployment_id} | Get Job Deployment
166
+ *EXTERNALApi* | [**get_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_get**](docs/EXTERNALApi.md#get_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_get) | **GET** /clusters/{cluster_id}/organizations/{organization_id}/gpu-quota | Get Org Gpu Quota On Cluster
167
+ *EXTERNALApi* | [**get_prebuilt_images_prebuilt_images_get**](docs/EXTERNALApi.md#get_prebuilt_images_prebuilt_images_get) | **GET** /prebuilt-images | Get Prebuilt Images
168
+ *EXTERNALApi* | [**get_unified_deployment_deployments_deployment_id_get**](docs/EXTERNALApi.md#get_unified_deployment_deployments_deployment_id_get) | **GET** /deployments/{deployment_id} | Get Unified Deployment
169
+ *EXTERNALApi* | [**get_unified_deployment_logs_deployments_deployment_id_revisions_revision_number_logs_get**](docs/EXTERNALApi.md#get_unified_deployment_logs_deployments_deployment_id_revisions_revision_number_logs_get) | **GET** /deployments/{deployment_id}/revisions/{revision_number}/logs | Get Unified Deployment Logs
170
+ *EXTERNALApi* | [**get_unified_deployment_pods_deployments_deployment_id_revisions_revision_number_pods_get**](docs/EXTERNALApi.md#get_unified_deployment_pods_deployments_deployment_id_revisions_revision_number_pods_get) | **GET** /deployments/{deployment_id}/revisions/{revision_number}/pods | Get Unified Deployment Pods
171
+ *EXTERNALApi* | [**get_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_get**](docs/EXTERNALApi.md#get_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_get) | **GET** /deployments/{deployment_id}/revisions/{revision_number} | Get Unified Deployment Revision
172
+ *EXTERNALApi* | [**get_unified_deployment_rollout_deployments_deployment_id_rollout_get**](docs/EXTERNALApi.md#get_unified_deployment_rollout_deployments_deployment_id_rollout_get) | **GET** /deployments/{deployment_id}/rollout | Get Unified Deployment Rollout
173
+ *EXTERNALApi* | [**get_unified_deployment_usage_deployments_deployment_id_usage_get**](docs/EXTERNALApi.md#get_unified_deployment_usage_deployments_deployment_id_usage_get) | **GET** /deployments/{deployment_id}/usage | Get Unified Deployment Usage
174
+ *EXTERNALApi* | [**get_usage_daily_bills_get**](docs/EXTERNALApi.md#get_usage_daily_bills_get) | **GET** /daily_bills | Get Usage
175
+ *EXTERNALApi* | [**get_usage_deployments_usage_deployment_id_get**](docs/EXTERNALApi.md#get_usage_deployments_usage_deployment_id_get) | **GET** /deployments/usage/{deployment_id} | Get Usage
176
+ *EXTERNALApi* | [**get_user_vault_item_by_id_endpoint_user_vault_secret_id_get**](docs/EXTERNALApi.md#get_user_vault_item_by_id_endpoint_user_vault_secret_id_get) | **GET** /user_vault/{secret_id} | Get User Vault Item By Id Endpoint
177
+ *EXTERNALApi* | [**get_volume_endpoint_volumes_volume_id_get**](docs/EXTERNALApi.md#get_volume_endpoint_volumes_volume_id_get) | **GET** /volumes/{volume_id} | Get Volume Endpoint
178
+ *EXTERNALApi* | [**get_volume_status_endpoint_volumes_status_volume_id_get**](docs/EXTERNALApi.md#get_volume_status_endpoint_volumes_status_volume_id_get) | **GET** /volumes/status/{volume_id} | Get Volume Status Endpoint
179
+ *EXTERNALApi* | [**invite_user_organizations_invite_post**](docs/EXTERNALApi.md#invite_user_organizations_invite_post) | **POST** /organizations/invite | Invite User
180
+ *EXTERNALApi* | [**list_cluster_capacity_capacity_get**](docs/EXTERNALApi.md#list_cluster_capacity_capacity_get) | **GET** /capacity | List Cluster Capacity
181
+ *EXTERNALApi* | [**list_cluster_org_gpu_quotas_clusters_cluster_id_gpu_quota_organizations_get**](docs/EXTERNALApi.md#list_cluster_org_gpu_quotas_clusters_cluster_id_gpu_quota_organizations_get) | **GET** /clusters/{cluster_id}/gpu-quota/organizations | List Cluster Org Gpu Quotas
182
+ *EXTERNALApi* | [**list_insights_insights_get**](docs/EXTERNALApi.md#list_insights_insights_get) | **GET** /insights | List Insights
183
+ *EXTERNALApi* | [**list_service_accounts_service_accounts_get**](docs/EXTERNALApi.md#list_service_accounts_service_accounts_get) | **GET** /service-accounts | List Service Accounts
184
+ *EXTERNALApi* | [**list_unified_deployment_revisions_deployments_deployment_id_revisions_get**](docs/EXTERNALApi.md#list_unified_deployment_revisions_deployments_deployment_id_revisions_get) | **GET** /deployments/{deployment_id}/revisions | List Unified Deployment Revisions
185
+ *EXTERNALApi* | [**put_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_put**](docs/EXTERNALApi.md#put_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_put) | **PUT** /clusters/{cluster_id}/organizations/{organization_id}/gpu-quota | Put Org Gpu Quota On Cluster
186
+ *EXTERNALApi* | [**rollout_existing_revision_deployments_revisions_deployment_id_revision_number_put**](docs/EXTERNALApi.md#rollout_existing_revision_deployments_revisions_deployment_id_revision_number_put) | **PUT** /deployments/revisions/{deployment_id}/{revision_number} | Rollout Existing Revision
187
+ *EXTERNALApi* | [**rollout_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_put**](docs/EXTERNALApi.md#rollout_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_put) | **PUT** /deployments/{deployment_id}/revisions/{revision_number} | Rollout Unified Deployment Revision
188
+ *EXTERNALApi* | [**setup_stripe_customer_payments_setup_post**](docs/EXTERNALApi.md#setup_stripe_customer_payments_setup_post) | **POST** /payments/setup | Setup Stripe Customer
189
+ *EXTERNALApi* | [**update_cluster_clusters_cluster_id_put**](docs/EXTERNALApi.md#update_cluster_clusters_cluster_id_put) | **PUT** /clusters/{cluster_id} | Update Cluster
190
+ *EXTERNALApi* | [**update_cluster_metadata_clusters_cluster_id_metadata_put**](docs/EXTERNALApi.md#update_cluster_metadata_clusters_cluster_id_metadata_put) | **PUT** /clusters/{cluster_id}/metadata | Update Cluster Metadata
191
+ *EXTERNALApi* | [**update_compute_deployment_deployments_compute_put**](docs/EXTERNALApi.md#update_compute_deployment_deployments_compute_put) | **PUT** /deployments/compute | Update Compute Deployment
192
+ *EXTERNALApi* | [**update_cserve_deployment_deployments_cserve_put**](docs/EXTERNALApi.md#update_cserve_deployment_deployments_cserve_put) | **PUT** /deployments/cserve | Retired Cserve Deployment
193
+ *EXTERNALApi* | [**update_cserve_v2_deployment_deployments_cserve_v2_put**](docs/EXTERNALApi.md#update_cserve_v2_deployment_deployments_cserve_v2_put) | **PUT** /deployments/cserve_v2 | Retired Cserve Deployment
194
+ *EXTERNALApi* | [**update_cserve_v3_deployment_deployments_cserve_v3_put**](docs/EXTERNALApi.md#update_cserve_v3_deployment_deployments_cserve_v3_put) | **PUT** /deployments/cserve_v3 | Retired Cserve Deployment
195
+ *EXTERNALApi* | [**update_deployment_status_deployments_status_deployment_id_put**](docs/EXTERNALApi.md#update_deployment_status_deployments_status_deployment_id_put) | **PUT** /deployments/status/{deployment_id} | Update Deployment Status
196
+ *EXTERNALApi* | [**update_deployment_status_v3_deployments_status_v3_deployment_id_put**](docs/EXTERNALApi.md#update_deployment_status_v3_deployments_status_v3_deployment_id_put) | **PUT** /deployments/status_v3/{deployment_id} | Update Deployment Status V3
197
+ *EXTERNALApi* | [**update_dynamo_deployment_deployments_dynamo_put**](docs/EXTERNALApi.md#update_dynamo_deployment_deployments_dynamo_put) | **PUT** /deployments/dynamo | Update Dynamo Deployment
198
+ *EXTERNALApi* | [**update_inference_deployment_deployments_inference_put**](docs/EXTERNALApi.md#update_inference_deployment_deployments_inference_put) | **PUT** /deployments/inference | Update Inference Deployment
199
+ *EXTERNALApi* | [**update_inference_v3_deployment_deployments_inference_v3_put**](docs/EXTERNALApi.md#update_inference_v3_deployment_deployments_inference_v3_put) | **PUT** /deployments/inference_v3 | Update Inference V3 Deployment
200
+ *EXTERNALApi* | [**update_insight_status_insights_insight_id_status_patch**](docs/EXTERNALApi.md#update_insight_status_insights_insight_id_status_patch) | **PATCH** /insights/{insight_id}/status | Update Insight Status
201
+ *EXTERNALApi* | [**update_service_account_service_accounts_workos_id_put**](docs/EXTERNALApi.md#update_service_account_service_accounts_workos_id_put) | **PUT** /service-accounts/{workos_id} | Update Service Account
202
+ *EXTERNALApi* | [**update_unified_deployment_deployments_deployment_id_put**](docs/EXTERNALApi.md#update_unified_deployment_deployments_deployment_id_put) | **PUT** /deployments/{deployment_id} | Update Unified Deployment
203
+ *EXTERNALApi* | [**update_unified_deployment_rollout_deployments_deployment_id_rollout_put**](docs/EXTERNALApi.md#update_unified_deployment_rollout_deployments_deployment_id_rollout_put) | **PUT** /deployments/{deployment_id}/rollout | Update Unified Deployment Rollout
204
+ *EXTERNALApi* | [**update_unified_deployment_status_deployments_deployment_id_status_put**](docs/EXTERNALApi.md#update_unified_deployment_status_deployments_deployment_id_status_put) | **PUT** /deployments/{deployment_id}/status | Update Unified Deployment Status
205
+ *EXTERNALApi* | [**update_user_vault_item_endpoint_user_vault_put**](docs/EXTERNALApi.md#update_user_vault_item_endpoint_user_vault_put) | **PUT** /user_vault | Update User Vault Item Endpoint
206
+
207
+
208
+ ## Documentation For Models
209
+
210
+ - [Admission](docs/Admission.md)
211
+ - [Autoscaling](docs/Autoscaling.md)
212
+ - [BackendProtocol](docs/BackendProtocol.md)
213
+ - [CDI](docs/CDI.md)
214
+ - [CNI](docs/CNI.md)
215
+ - [CclDynamoPools](docs/CclDynamoPools.md)
216
+ - [CclMainPools](docs/CclMainPools.md)
217
+ - [CclusterCatalogsClusterBaseArgoRolloutsChartValues](docs/CclusterCatalogsClusterBaseArgoRolloutsChartValues.md)
218
+ - [CclusterCatalogsClusterBaseArgoRolloutsController](docs/CclusterCatalogsClusterBaseArgoRolloutsController.md)
219
+ - [CclusterCatalogsClusterBaseArgoRolloutsValues](docs/CclusterCatalogsClusterBaseArgoRolloutsValues.md)
220
+ - [CclusterCatalogsClusterBaseCertManagerChartValues](docs/CclusterCatalogsClusterBaseCertManagerChartValues.md)
221
+ - [CclusterCatalogsClusterBaseCertManagerValues](docs/CclusterCatalogsClusterBaseCertManagerValues.md)
222
+ - [CclusterCatalogsClusterBaseGpuOperatorChartValues](docs/CclusterCatalogsClusterBaseGpuOperatorChartValues.md)
223
+ - [CclusterCatalogsClusterBaseGpuOperatorValues](docs/CclusterCatalogsClusterBaseGpuOperatorValues.md)
224
+ - [CclusterCatalogsClusterBaseIngressNginxChartValues](docs/CclusterCatalogsClusterBaseIngressNginxChartValues.md)
225
+ - [CclusterCatalogsClusterBaseIngressNginxController](docs/CclusterCatalogsClusterBaseIngressNginxController.md)
226
+ - [CclusterCatalogsClusterBaseIngressNginxValues](docs/CclusterCatalogsClusterBaseIngressNginxValues.md)
227
+ - [CclusterCatalogsClusterBaseIstioValues](docs/CclusterCatalogsClusterBaseIstioValues.md)
228
+ - [CclusterCatalogsClusterBaseKaiSchedulerChartValues](docs/CclusterCatalogsClusterBaseKaiSchedulerChartValues.md)
229
+ - [CclusterCatalogsClusterBaseKaiSchedulerValues](docs/CclusterCatalogsClusterBaseKaiSchedulerValues.md)
230
+ - [CclusterCatalogsClusterBaseKedaChartValues](docs/CclusterCatalogsClusterBaseKedaChartValues.md)
231
+ - [CclusterCatalogsClusterBaseKedaValues](docs/CclusterCatalogsClusterBaseKedaValues.md)
232
+ - [CclusterCatalogsClusterBaseKubePrometheusStackChartValues](docs/CclusterCatalogsClusterBaseKubePrometheusStackChartValues.md)
233
+ - [CclusterCatalogsClusterBaseKubePrometheusStackValues](docs/CclusterCatalogsClusterBaseKubePrometheusStackValues.md)
234
+ - [CclusterCatalogsClusterBaseMetricsServerChartValues](docs/CclusterCatalogsClusterBaseMetricsServerChartValues.md)
235
+ - [CclusterCatalogsClusterBaseMetricsServerValues](docs/CclusterCatalogsClusterBaseMetricsServerValues.md)
236
+ - [CloudProvider](docs/CloudProvider.md)
237
+ - [ClusterBaseComponents](docs/ClusterBaseComponents.md)
238
+ - [ClusterCapacityResponse](docs/ClusterCapacityResponse.md)
239
+ - [ClusterCredential](docs/ClusterCredential.md)
240
+ - [ClusterRegistrationRequest](docs/ClusterRegistrationRequest.md)
241
+ - [ClusterRegistrationResponse](docs/ClusterRegistrationResponse.md)
242
+ - [ConfigFileMount](docs/ConfigFileMount.md)
243
+ - [CreateComputeDeploymentRequest](docs/CreateComputeDeploymentRequest.md)
244
+ - [CreateComputeDeploymentResponse](docs/CreateComputeDeploymentResponse.md)
245
+ - [CreateDynamoDeploymentRequest](docs/CreateDynamoDeploymentRequest.md)
246
+ - [CreateDynamoDeploymentResponse](docs/CreateDynamoDeploymentResponse.md)
247
+ - [CreateFilesystemVolumeRequest](docs/CreateFilesystemVolumeRequest.md)
248
+ - [CreateHardwareInstanceRequest](docs/CreateHardwareInstanceRequest.md)
249
+ - [CreateInferenceDeploymentResponse](docs/CreateInferenceDeploymentResponse.md)
250
+ - [CreateInferenceV3DeploymentRequest](docs/CreateInferenceV3DeploymentRequest.md)
251
+ - [CreateJobDeploymentRequest](docs/CreateJobDeploymentRequest.md)
252
+ - [CreateJobDeploymentResponse](docs/CreateJobDeploymentResponse.md)
253
+ - [CreateObjectVolumeRequest](docs/CreateObjectVolumeRequest.md)
254
+ - [CreateOrganizationRequest](docs/CreateOrganizationRequest.md)
255
+ - [CreateOrganizationResponse](docs/CreateOrganizationResponse.md)
256
+ - [CreateServiceAccountRequest](docs/CreateServiceAccountRequest.md)
257
+ - [CreateServiceAccountResponse](docs/CreateServiceAccountResponse.md)
258
+ - [CreateVolumeRequest](docs/CreateVolumeRequest.md)
259
+ - [CreditsResponse](docs/CreditsResponse.md)
260
+ - [DailyBillResponse](docs/DailyBillResponse.md)
261
+ - [Dashboard](docs/Dashboard.md)
262
+ - [DefaultPriorities](docs/DefaultPriorities.md)
263
+ - [DefaultQueue](docs/DefaultQueue.md)
264
+ - [DeleteUserVaultItemRequest](docs/DeleteUserVaultItemRequest.md)
265
+ - [DeploymentComponentType](docs/DeploymentComponentType.md)
266
+ - [DeploymentLogEventV4](docs/DeploymentLogEventV4.md)
267
+ - [DeploymentResponse](docs/DeploymentResponse.md)
268
+ - [DeploymentStatus](docs/DeploymentStatus.md)
269
+ - [DeploymentStatusRequest](docs/DeploymentStatusRequest.md)
270
+ - [DeploymentStatusResponse](docs/DeploymentStatusResponse.md)
271
+ - [DeploymentStatusV3Response](docs/DeploymentStatusV3Response.md)
272
+ - [DeploymentType](docs/DeploymentType.md)
273
+ - [DeploymentUsage](docs/DeploymentUsage.md)
274
+ - [DeploymentUsageValue](docs/DeploymentUsageValue.md)
275
+ - [DynamoCommunicationsInput](docs/DynamoCommunicationsInput.md)
276
+ - [DynamoFrontendConfig](docs/DynamoFrontendConfig.md)
277
+ - [DynamoFrontendConfigResponse](docs/DynamoFrontendConfigResponse.md)
278
+ - [DynamoImage](docs/DynamoImage.md)
279
+ - [DynamoKvTransferConfiguration](docs/DynamoKvTransferConfiguration.md)
280
+ - [DynamoKvTransferPolicy](docs/DynamoKvTransferPolicy.md)
281
+ - [DynamoServingMode](docs/DynamoServingMode.md)
282
+ - [DynamoWeightTransferConfiguration](docs/DynamoWeightTransferConfiguration.md)
283
+ - [DynamoWeightTransferPolicy](docs/DynamoWeightTransferPolicy.md)
284
+ - [DynamoWorkerPoolConfig](docs/DynamoWorkerPoolConfig.md)
285
+ - [DynamoWorkerPools](docs/DynamoWorkerPools.md)
286
+ - [Env](docs/Env.md)
287
+ - [GenerateServiceAccountSecretResponse](docs/GenerateServiceAccountSecretResponse.md)
288
+ - [GetClusterResponse](docs/GetClusterResponse.md)
289
+ - [GetComputeDeploymentResponse](docs/GetComputeDeploymentResponse.md)
290
+ - [GetDeploymentLogResponse](docs/GetDeploymentLogResponse.md)
291
+ - [GetDeploymentLogV4Response](docs/GetDeploymentLogV4Response.md)
292
+ - [GetDeploymentPodsResponse](docs/GetDeploymentPodsResponse.md)
293
+ - [GetDeploymentResponse](docs/GetDeploymentResponse.md)
294
+ - [GetDeploymentRevisionResponse](docs/GetDeploymentRevisionResponse.md)
295
+ - [GetDeploymentUsageResponse](docs/GetDeploymentUsageResponse.md)
296
+ - [GetDynamoDeploymentResponse](docs/GetDynamoDeploymentResponse.md)
297
+ - [GetFilesystemVolumeResponse](docs/GetFilesystemVolumeResponse.md)
298
+ - [GetInferenceDeploymentResponse](docs/GetInferenceDeploymentResponse.md)
299
+ - [GetInferenceV3DeploymentResponse](docs/GetInferenceV3DeploymentResponse.md)
300
+ - [GetJobDeploymentResponse](docs/GetJobDeploymentResponse.md)
301
+ - [GetObjectVolumeResponse](docs/GetObjectVolumeResponse.md)
302
+ - [GetVolumeResponse](docs/GetVolumeResponse.md)
303
+ - [GpuTypeCapacity](docs/GpuTypeCapacity.md)
304
+ - [HTTPValidationError](docs/HTTPValidationError.md)
305
+ - [HardwareInstanceResponse](docs/HardwareInstanceResponse.md)
306
+ - [HardwarePresetResponse](docs/HardwarePresetResponse.md)
307
+ - [Image](docs/Image.md)
308
+ - [ImagePullSecretCredentials](docs/ImagePullSecretCredentials.md)
309
+ - [Ingress](docs/Ingress.md)
310
+ - [InsightListItemResponse](docs/InsightListItemResponse.md)
311
+ - [InsightResource](docs/InsightResource.md)
312
+ - [InsightResourceType](docs/InsightResourceType.md)
313
+ - [InsightResponse](docs/InsightResponse.md)
314
+ - [InsightSeverity](docs/InsightSeverity.md)
315
+ - [InsightStatus](docs/InsightStatus.md)
316
+ - [InsightStatusChangeResponse](docs/InsightStatusChangeResponse.md)
317
+ - [InviteUserRequest](docs/InviteUserRequest.md)
318
+ - [IstioBase](docs/IstioBase.md)
319
+ - [IstioCNI](docs/IstioCNI.md)
320
+ - [IstioGateway](docs/IstioGateway.md)
321
+ - [Istiod](docs/Istiod.md)
322
+ - [ListClusterCapacityResponse](docs/ListClusterCapacityResponse.md)
323
+ - [ListDailyBillResponse](docs/ListDailyBillResponse.md)
324
+ - [ListDeploymentRevisionsResponse](docs/ListDeploymentRevisionsResponse.md)
325
+ - [ListGetClusterResponse](docs/ListGetClusterResponse.md)
326
+ - [ListGetDeploymentResponse](docs/ListGetDeploymentResponse.md)
327
+ - [ListHardwareInstanceResponse](docs/ListHardwareInstanceResponse.md)
328
+ - [ListHardwarePresetResponse](docs/ListHardwarePresetResponse.md)
329
+ - [ListInsightsResponse](docs/ListInsightsResponse.md)
330
+ - [ListOrganizationGpuQuotaResponse](docs/ListOrganizationGpuQuotaResponse.md)
331
+ - [ListPrebuiltImageResponse](docs/ListPrebuiltImageResponse.md)
332
+ - [ListServiceAccountsResponse](docs/ListServiceAccountsResponse.md)
333
+ - [ListUserVaultItemsResponse](docs/ListUserVaultItemsResponse.md)
334
+ - [ListVolumesResponse](docs/ListVolumesResponse.md)
335
+ - [LocationInner](docs/LocationInner.md)
336
+ - [MIG](docs/MIG.md)
337
+ - [Metric](docs/Metric.md)
338
+ - [Metrics](docs/Metrics.md)
339
+ - [MetricsConfig](docs/MetricsConfig.md)
340
+ - [ObjectStorageProvider](docs/ObjectStorageProvider.md)
341
+ - [Operator](docs/Operator.md)
342
+ - [OrganizationGpuQuotaRequest](docs/OrganizationGpuQuotaRequest.md)
343
+ - [OrganizationGpuQuotaResponse](docs/OrganizationGpuQuotaResponse.md)
344
+ - [Pilot](docs/Pilot.md)
345
+ - [PodDetails](docs/PodDetails.md)
346
+ - [PodStatus](docs/PodStatus.md)
347
+ - [Pool](docs/Pool.md)
348
+ - [PrebuiltImageResponse](docs/PrebuiltImageResponse.md)
349
+ - [Prometheus](docs/Prometheus.md)
350
+ - [PrometheusRules](docs/PrometheusRules.md)
351
+ - [PrometheusSpec](docs/PrometheusSpec.md)
352
+ - [PrometheusValues](docs/PrometheusValues.md)
353
+ - [Quota](docs/Quota.md)
354
+ - [Replicas](docs/Replicas.md)
355
+ - [ResourceList](docs/ResourceList.md)
356
+ - [ResourceRequirements](docs/ResourceRequirements.md)
357
+ - [RevisionPodDetails](docs/RevisionPodDetails.md)
358
+ - [RolloutStatus](docs/RolloutStatus.md)
359
+ - [RolloutStrategyParams](docs/RolloutStrategyParams.md)
360
+ - [Scheduler](docs/Scheduler.md)
361
+ - [ServiceAccountResponse](docs/ServiceAccountResponse.md)
362
+ - [ServiceStatus](docs/ServiceStatus.md)
363
+ - [Toggle](docs/Toggle.md)
364
+ - [Toleration](docs/Toleration.md)
365
+ - [UnifiedGetComputeDeploymentResponse](docs/UnifiedGetComputeDeploymentResponse.md)
366
+ - [UnifiedGetDeploymentLogsResponse](docs/UnifiedGetDeploymentLogsResponse.md)
367
+ - [UnifiedGetDeploymentPodsResponse](docs/UnifiedGetDeploymentPodsResponse.md)
368
+ - [UnifiedGetDeploymentResponse](docs/UnifiedGetDeploymentResponse.md)
369
+ - [UnifiedGetDeploymentRevisionResponse](docs/UnifiedGetDeploymentRevisionResponse.md)
370
+ - [UnifiedGetDeploymentRolloutResponse](docs/UnifiedGetDeploymentRolloutResponse.md)
371
+ - [UnifiedGetDeploymentUsageResponse](docs/UnifiedGetDeploymentUsageResponse.md)
372
+ - [UnifiedGetDynamoDeploymentResponse](docs/UnifiedGetDynamoDeploymentResponse.md)
373
+ - [UnifiedGetInferenceV3DeploymentResponse](docs/UnifiedGetInferenceV3DeploymentResponse.md)
374
+ - [UnifiedGetJobDeploymentResponse](docs/UnifiedGetJobDeploymentResponse.md)
375
+ - [UnifiedListDeploymentRevisionsResponse](docs/UnifiedListDeploymentRevisionsResponse.md)
376
+ - [UnifiedUpdateDeploymentRolloutRequest](docs/UnifiedUpdateDeploymentRolloutRequest.md)
377
+ - [UnifiedWriteComputeDeploymentRequest](docs/UnifiedWriteComputeDeploymentRequest.md)
378
+ - [UnifiedWriteDeploymentRequest](docs/UnifiedWriteDeploymentRequest.md)
379
+ - [UnifiedWriteDeploymentResponse](docs/UnifiedWriteDeploymentResponse.md)
380
+ - [UnifiedWriteDynamoDeploymentRequest](docs/UnifiedWriteDynamoDeploymentRequest.md)
381
+ - [UnifiedWriteInferenceV3DeploymentRequest](docs/UnifiedWriteInferenceV3DeploymentRequest.md)
382
+ - [UnifiedWriteJobDeploymentRequest](docs/UnifiedWriteJobDeploymentRequest.md)
383
+ - [UpdateClusterMetadataRequest](docs/UpdateClusterMetadataRequest.md)
384
+ - [UpdateClusterRequest](docs/UpdateClusterRequest.md)
385
+ - [UpdateDeploymentResponse](docs/UpdateDeploymentResponse.md)
386
+ - [UpdateDeploymentStatusV3Request](docs/UpdateDeploymentStatusV3Request.md)
387
+ - [UpdateInsightStatusRequest](docs/UpdateInsightStatusRequest.md)
388
+ - [UpdateServiceAccountRequest](docs/UpdateServiceAccountRequest.md)
389
+ - [UpsertUserVaultItemRequest](docs/UpsertUserVaultItemRequest.md)
390
+ - [UsageAvailability](docs/UsageAvailability.md)
391
+ - [UsageComponent](docs/UsageComponent.md)
392
+ - [UserVaultItem](docs/UserVaultItem.md)
393
+ - [UserVaultType](docs/UserVaultType.md)
394
+ - [ValidationError](docs/ValidationError.md)
395
+ - [VaultScope](docs/VaultScope.md)
396
+ - [VolumeAccessMode](docs/VolumeAccessMode.md)
397
+ - [VolumeBackend](docs/VolumeBackend.md)
398
+ - [VolumeMount](docs/VolumeMount.md)
399
+ - [VolumeStatus](docs/VolumeStatus.md)
400
+ - [VolumeStatusResponse](docs/VolumeStatusResponse.md)
401
+ - [Workload](docs/Workload.md)
402
+
403
+
404
+ <a id="documentation-for-authorization"></a>
405
+ ## Documentation For Authorization
406
+
407
+
408
+ Authentication schemes defined for the API:
409
+ <a id="HTTPBearer"></a>
410
+ ### HTTPBearer
411
+
412
+ - **Type**: Bearer authentication
413
+
414
+
415
+ ## Author
416
+
417
+
418
+