EXTERNALApi.md

# platform_api_python_client.EXTERNALApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_cluster_clusters_post**](EXTERNALApi.md#create_cluster_clusters_post) | **POST** /clusters | Create Cluster
[**create_compute_deployment_deployments_compute_post**](EXTERNALApi.md#create_compute_deployment_deployments_compute_post) | **POST** /deployments/compute | Create Compute Deployment
[**create_cserve_deployment_deployments_cserve_post**](EXTERNALApi.md#create_cserve_deployment_deployments_cserve_post) | **POST** /deployments/cserve | Retired Cserve Deployment
[**create_cserve_v2_deployment_deployments_cserve_v2_post**](EXTERNALApi.md#create_cserve_v2_deployment_deployments_cserve_v2_post) | **POST** /deployments/cserve_v2 | Retired Cserve Deployment
[**create_cserve_v3_deployment_deployments_cserve_v3_post**](EXTERNALApi.md#create_cserve_v3_deployment_deployments_cserve_v3_post) | **POST** /deployments/cserve_v3 | Retired Cserve Deployment
[**create_dynamo_deployment_deployments_dynamo_post**](EXTERNALApi.md#create_dynamo_deployment_deployments_dynamo_post) | **POST** /deployments/dynamo | Create Dynamo Deployment
[**create_hardware_instance_hardware_instances_post**](EXTERNALApi.md#create_hardware_instance_hardware_instances_post) | **POST** /hardware-instances | Create Hardware Instance
[**create_inference_deployment_deployments_inference_post**](EXTERNALApi.md#create_inference_deployment_deployments_inference_post) | **POST** /deployments/inference | Create Inference Deployment
[**create_inference_v3_deployment_deployments_inference_v3_post**](EXTERNALApi.md#create_inference_v3_deployment_deployments_inference_v3_post) | **POST** /deployments/inference_v3 | Create Inference V3 Deployment
[**create_job_deployment_deployments_job_post**](EXTERNALApi.md#create_job_deployment_deployments_job_post) | **POST** /deployments/job | Create Job Deployment
[**create_new_organization_organizations_post**](EXTERNALApi.md#create_new_organization_organizations_post) | **POST** /organizations | Create New Organization
[**create_service_account_service_accounts_post**](EXTERNALApi.md#create_service_account_service_accounts_post) | **POST** /service-accounts | Create Service Account
[**create_unified_deployment_deployments_post**](EXTERNALApi.md#create_unified_deployment_deployments_post) | **POST** /deployments | Create Unified Deployment
[**create_volume_endpoint_volumes_post**](EXTERNALApi.md#create_volume_endpoint_volumes_post) | **POST** /volumes | Create Volume Endpoint
[**delete_cluster_clusters_cluster_id_delete**](EXTERNALApi.md#delete_cluster_clusters_cluster_id_delete) | **DELETE** /clusters/{cluster_id} | Delete Cluster
[**delete_hardware_instance_hardware_instances_hardware_instance_id_delete**](EXTERNALApi.md#delete_hardware_instance_hardware_instances_hardware_instance_id_delete) | **DELETE** /hardware-instances/{hardware_instance_id} | Delete Hardware Instance
[**delete_service_account_service_accounts_workos_id_delete**](EXTERNALApi.md#delete_service_account_service_accounts_workos_id_delete) | **DELETE** /service-accounts/{workos_id} | Delete Service Account
[**delete_unified_deployment_deployments_deployment_id_delete**](EXTERNALApi.md#delete_unified_deployment_deployments_deployment_id_delete) | **DELETE** /deployments/{deployment_id} | Delete Unified Deployment
[**delete_user_vault_item_by_id_endpoint_user_vault_secret_id_delete**](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
[**delete_user_vault_item_endpoint_user_vault_delete**](EXTERNALApi.md#delete_user_vault_item_endpoint_user_vault_delete) | **DELETE** /user_vault | Delete User Vault Item Endpoint
[**delete_volume_endpoint_volumes_volume_id_delete**](EXTERNALApi.md#delete_volume_endpoint_volumes_volume_id_delete) | **DELETE** /volumes/{volume_id} | Delete Volume Endpoint
[**generate_service_account_secret_service_accounts_workos_id_secrets_post**](EXTERNALApi.md#generate_service_account_secret_service_accounts_workos_id_secrets_post) | **POST** /service-accounts/{workos_id}/secrets | Generate Service Account Secret
[**get_all_user_vault_items_endpoint_user_vault_get**](EXTERNALApi.md#get_all_user_vault_items_endpoint_user_vault_get) | **GET** /user_vault | Get All User Vault Items Endpoint
[**get_all_volumes_endpoint_volumes_get**](EXTERNALApi.md#get_all_volumes_endpoint_volumes_get) | **GET** /volumes | Get All Volumes Endpoint
[**get_clusters_clusters_get**](EXTERNALApi.md#get_clusters_clusters_get) | **GET** /clusters | Get Clusters
[**get_compute_deployment_deployments_compute_deployment_id_get**](EXTERNALApi.md#get_compute_deployment_deployments_compute_deployment_id_get) | **GET** /deployments/compute/{deployment_id} | Get Compute Deployment
[**get_credits_credits_get**](EXTERNALApi.md#get_credits_credits_get) | **GET** /credits | Get Credits
[**get_cserve_deployment_deployments_cserve_deployment_id_get**](EXTERNALApi.md#get_cserve_deployment_deployments_cserve_deployment_id_get) | **GET** /deployments/cserve/{deployment_id} | Retired Cserve Deployment Detail
[**get_cserve_v2_deployment_deployments_cserve_v2_deployment_id_get**](EXTERNALApi.md#get_cserve_v2_deployment_deployments_cserve_v2_deployment_id_get) | **GET** /deployments/cserve_v2/{deployment_id} | Retired Cserve Deployment Detail
[**get_cserve_v3_deployment_deployments_cserve_v3_deployment_id_get**](EXTERNALApi.md#get_cserve_v3_deployment_deployments_cserve_v3_deployment_id_get) | **GET** /deployments/cserve_v3/{deployment_id} | Retired Cserve Deployment Detail
[**get_current_org_gpu_quota_organizations_gpu_quota_get**](EXTERNALApi.md#get_current_org_gpu_quota_organizations_gpu_quota_get) | **GET** /organizations/gpu-quota | Get Current Org Gpu Quota
[**get_deployment_logs_deployments_logs_deployment_id_get**](EXTERNALApi.md#get_deployment_logs_deployments_logs_deployment_id_get) | **GET** /deployments/logs/{deployment_id} | Get Deployment Logs
[**get_deployment_logs_v3_deployments_logs_v3_deployment_id_revision_number_get**](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
[**get_deployment_logs_v4_logs_deployment_id_revision_number_get**](EXTERNALApi.md#get_deployment_logs_v4_logs_deployment_id_revision_number_get) | **GET** /logs/{deployment_id}/{revision_number} | Get Deployment Logs V4
[**get_deployment_pods_deployments_pods_deployment_id_revision_number_get**](EXTERNALApi.md#get_deployment_pods_deployments_pods_deployment_id_revision_number_get) | **GET** /deployments/pods/{deployment_id}/{revision_number} | Get Deployment Pods
[**get_deployment_revision_deployments_revisions_deployment_id_revision_number_get**](EXTERNALApi.md#get_deployment_revision_deployments_revisions_deployment_id_revision_number_get) | **GET** /deployments/revisions/{deployment_id}/{revision_number} | Get Deployment Revision
[**get_deployment_revisions_deployments_revisions_deployment_id_get**](EXTERNALApi.md#get_deployment_revisions_deployments_revisions_deployment_id_get) | **GET** /deployments/revisions/{deployment_id} | Get Deployment Revisions
[**get_deployment_status_deployments_status_deployment_id_get**](EXTERNALApi.md#get_deployment_status_deployments_status_deployment_id_get) | **GET** /deployments/status/{deployment_id} | Get Deployment Status
[**get_deployment_status_v3_deployments_status_v3_deployment_id_get**](EXTERNALApi.md#get_deployment_status_v3_deployments_status_v3_deployment_id_get) | **GET** /deployments/status_v3/{deployment_id} | Get Deployment Status V3
[**get_deployments_deployments_get**](EXTERNALApi.md#get_deployments_deployments_get) | **GET** /deployments | Get Deployments
[**get_dynamo_deployment_deployments_dynamo_deployment_id_get**](EXTERNALApi.md#get_dynamo_deployment_deployments_dynamo_deployment_id_get) | **GET** /deployments/dynamo/{deployment_id} | Get Dynamo Deployment
[**get_hardware_instances_hardware_instances_get**](EXTERNALApi.md#get_hardware_instances_hardware_instances_get) | **GET** /hardware-instances | Get Hardware Instances
[**get_hardware_presets_hardware_instances_presets_get**](EXTERNALApi.md#get_hardware_presets_hardware_instances_presets_get) | **GET** /hardware-instances/presets | Get Hardware Presets
[**get_inference_deployment_deployments_inference_deployment_id_get**](EXTERNALApi.md#get_inference_deployment_deployments_inference_deployment_id_get) | **GET** /deployments/inference/{deployment_id} | Get Inference Deployment
[**get_inference_v3_deployment_deployments_inference_v3_deployment_id_get**](EXTERNALApi.md#get_inference_v3_deployment_deployments_inference_v3_deployment_id_get) | **GET** /deployments/inference_v3/{deployment_id} | Get Inference V3 Deployment
[**get_insight_insights_insight_id_get**](EXTERNALApi.md#get_insight_insights_insight_id_get) | **GET** /insights/{insight_id} | Get Insight
[**get_job_deployment_deployments_job_deployment_id_get**](EXTERNALApi.md#get_job_deployment_deployments_job_deployment_id_get) | **GET** /deployments/job/{deployment_id} | Get Job Deployment
[**get_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_get**](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
[**get_prebuilt_images_prebuilt_images_get**](EXTERNALApi.md#get_prebuilt_images_prebuilt_images_get) | **GET** /prebuilt-images | Get Prebuilt Images
[**get_unified_deployment_deployments_deployment_id_get**](EXTERNALApi.md#get_unified_deployment_deployments_deployment_id_get) | **GET** /deployments/{deployment_id} | Get Unified Deployment
[**get_unified_deployment_logs_deployments_deployment_id_revisions_revision_number_logs_get**](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
[**get_unified_deployment_pods_deployments_deployment_id_revisions_revision_number_pods_get**](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
[**get_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_get**](EXTERNALApi.md#get_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_get) | **GET** /deployments/{deployment_id}/revisions/{revision_number} | Get Unified Deployment Revision
[**get_unified_deployment_rollout_deployments_deployment_id_rollout_get**](EXTERNALApi.md#get_unified_deployment_rollout_deployments_deployment_id_rollout_get) | **GET** /deployments/{deployment_id}/rollout | Get Unified Deployment Rollout
[**get_unified_deployment_usage_deployments_deployment_id_usage_get**](EXTERNALApi.md#get_unified_deployment_usage_deployments_deployment_id_usage_get) | **GET** /deployments/{deployment_id}/usage | Get Unified Deployment Usage
[**get_usage_daily_bills_get**](EXTERNALApi.md#get_usage_daily_bills_get) | **GET** /daily_bills | Get Usage
[**get_usage_deployments_usage_deployment_id_get**](EXTERNALApi.md#get_usage_deployments_usage_deployment_id_get) | **GET** /deployments/usage/{deployment_id} | Get Usage
[**get_user_vault_item_by_id_endpoint_user_vault_secret_id_get**](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
[**get_volume_endpoint_volumes_volume_id_get**](EXTERNALApi.md#get_volume_endpoint_volumes_volume_id_get) | **GET** /volumes/{volume_id} | Get Volume Endpoint
[**get_volume_status_endpoint_volumes_status_volume_id_get**](EXTERNALApi.md#get_volume_status_endpoint_volumes_status_volume_id_get) | **GET** /volumes/status/{volume_id} | Get Volume Status Endpoint
[**invite_user_organizations_invite_post**](EXTERNALApi.md#invite_user_organizations_invite_post) | **POST** /organizations/invite | Invite User
[**list_cluster_capacity_capacity_get**](EXTERNALApi.md#list_cluster_capacity_capacity_get) | **GET** /capacity | List Cluster Capacity
[**list_cluster_org_gpu_quotas_clusters_cluster_id_gpu_quota_organizations_get**](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
[**list_insights_insights_get**](EXTERNALApi.md#list_insights_insights_get) | **GET** /insights | List Insights
[**list_service_accounts_service_accounts_get**](EXTERNALApi.md#list_service_accounts_service_accounts_get) | **GET** /service-accounts | List Service Accounts
[**list_unified_deployment_revisions_deployments_deployment_id_revisions_get**](EXTERNALApi.md#list_unified_deployment_revisions_deployments_deployment_id_revisions_get) | **GET** /deployments/{deployment_id}/revisions | List Unified Deployment Revisions
[**put_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_put**](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
[**rollout_existing_revision_deployments_revisions_deployment_id_revision_number_put**](EXTERNALApi.md#rollout_existing_revision_deployments_revisions_deployment_id_revision_number_put) | **PUT** /deployments/revisions/{deployment_id}/{revision_number} | Rollout Existing Revision
[**rollout_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_put**](EXTERNALApi.md#rollout_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_put) | **PUT** /deployments/{deployment_id}/revisions/{revision_number} | Rollout Unified Deployment Revision
[**setup_stripe_customer_payments_setup_post**](EXTERNALApi.md#setup_stripe_customer_payments_setup_post) | **POST** /payments/setup | Setup Stripe Customer
[**update_cluster_clusters_cluster_id_put**](EXTERNALApi.md#update_cluster_clusters_cluster_id_put) | **PUT** /clusters/{cluster_id} | Update Cluster
[**update_cluster_metadata_clusters_cluster_id_metadata_put**](EXTERNALApi.md#update_cluster_metadata_clusters_cluster_id_metadata_put) | **PUT** /clusters/{cluster_id}/metadata | Update Cluster Metadata
[**update_compute_deployment_deployments_compute_put**](EXTERNALApi.md#update_compute_deployment_deployments_compute_put) | **PUT** /deployments/compute | Update Compute Deployment
[**update_cserve_deployment_deployments_cserve_put**](EXTERNALApi.md#update_cserve_deployment_deployments_cserve_put) | **PUT** /deployments/cserve | Retired Cserve Deployment
[**update_cserve_v2_deployment_deployments_cserve_v2_put**](EXTERNALApi.md#update_cserve_v2_deployment_deployments_cserve_v2_put) | **PUT** /deployments/cserve_v2 | Retired Cserve Deployment
[**update_cserve_v3_deployment_deployments_cserve_v3_put**](EXTERNALApi.md#update_cserve_v3_deployment_deployments_cserve_v3_put) | **PUT** /deployments/cserve_v3 | Retired Cserve Deployment
[**update_deployment_status_deployments_status_deployment_id_put**](EXTERNALApi.md#update_deployment_status_deployments_status_deployment_id_put) | **PUT** /deployments/status/{deployment_id} | Update Deployment Status
[**update_deployment_status_v3_deployments_status_v3_deployment_id_put**](EXTERNALApi.md#update_deployment_status_v3_deployments_status_v3_deployment_id_put) | **PUT** /deployments/status_v3/{deployment_id} | Update Deployment Status V3
[**update_dynamo_deployment_deployments_dynamo_put**](EXTERNALApi.md#update_dynamo_deployment_deployments_dynamo_put) | **PUT** /deployments/dynamo | Update Dynamo Deployment
[**update_inference_deployment_deployments_inference_put**](EXTERNALApi.md#update_inference_deployment_deployments_inference_put) | **PUT** /deployments/inference | Update Inference Deployment
[**update_inference_v3_deployment_deployments_inference_v3_put**](EXTERNALApi.md#update_inference_v3_deployment_deployments_inference_v3_put) | **PUT** /deployments/inference_v3 | Update Inference V3 Deployment
[**update_insight_status_insights_insight_id_status_patch**](EXTERNALApi.md#update_insight_status_insights_insight_id_status_patch) | **PATCH** /insights/{insight_id}/status | Update Insight Status
[**update_service_account_service_accounts_workos_id_put**](EXTERNALApi.md#update_service_account_service_accounts_workos_id_put) | **PUT** /service-accounts/{workos_id} | Update Service Account
[**update_unified_deployment_deployments_deployment_id_put**](EXTERNALApi.md#update_unified_deployment_deployments_deployment_id_put) | **PUT** /deployments/{deployment_id} | Update Unified Deployment
[**update_unified_deployment_rollout_deployments_deployment_id_rollout_put**](EXTERNALApi.md#update_unified_deployment_rollout_deployments_deployment_id_rollout_put) | **PUT** /deployments/{deployment_id}/rollout | Update Unified Deployment Rollout
[**update_unified_deployment_status_deployments_deployment_id_status_put**](EXTERNALApi.md#update_unified_deployment_status_deployments_deployment_id_status_put) | **PUT** /deployments/{deployment_id}/status | Update Unified Deployment Status
[**update_user_vault_item_endpoint_user_vault_put**](EXTERNALApi.md#update_user_vault_item_endpoint_user_vault_put) | **PUT** /user_vault | Update User Vault Item Endpoint


# **create_cluster_clusters_post**
> ClusterRegistrationResponse create_cluster_clusters_post(cluster_registration_request)

Create Cluster

Register a cluster row for the caller's parent org.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.cluster_registration_request import ClusterRegistrationRequest
from platform_api_python_client.models.cluster_registration_response import ClusterRegistrationResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    cluster_registration_request = platform_api_python_client.ClusterRegistrationRequest() # ClusterRegistrationRequest | 

    try:
        # Create Cluster
        api_response = api_instance.create_cluster_clusters_post(cluster_registration_request)
        print("The response of EXTERNALApi->create_cluster_clusters_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_cluster_clusters_post: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cluster_registration_request** | [**ClusterRegistrationRequest**](ClusterRegistrationRequest.md)|  | 

### Return type

[**ClusterRegistrationResponse**](ClusterRegistrationResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_compute_deployment_deployments_compute_post**
> CreateComputeDeploymentResponse create_compute_deployment_deployments_compute_post(create_compute_deployment_request)

Create Compute Deployment

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.create_compute_deployment_request import CreateComputeDeploymentRequest
from platform_api_python_client.models.create_compute_deployment_response import CreateComputeDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    create_compute_deployment_request = platform_api_python_client.CreateComputeDeploymentRequest() # CreateComputeDeploymentRequest | 

    try:
        # Create Compute Deployment
        api_response = api_instance.create_compute_deployment_deployments_compute_post(create_compute_deployment_request)
        print("The response of EXTERNALApi->create_compute_deployment_deployments_compute_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_compute_deployment_deployments_compute_post: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **create_compute_deployment_request** | [**CreateComputeDeploymentRequest**](CreateComputeDeploymentRequest.md)|  | 

### Return type

[**CreateComputeDeploymentResponse**](CreateComputeDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_cserve_deployment_deployments_cserve_post**
> create_cserve_deployment_deployments_cserve_post()

Retired Cserve Deployment

### Example


```python
import platform_api_python_client
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)

    try:
        # Retired Cserve Deployment
        api_instance.create_cserve_deployment_deployments_cserve_post()
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_cserve_deployment_deployments_cserve_post: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**410** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_cserve_v2_deployment_deployments_cserve_v2_post**
> create_cserve_v2_deployment_deployments_cserve_v2_post()

Retired Cserve Deployment

### Example


```python
import platform_api_python_client
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)

    try:
        # Retired Cserve Deployment
        api_instance.create_cserve_v2_deployment_deployments_cserve_v2_post()
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_cserve_v2_deployment_deployments_cserve_v2_post: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**410** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_cserve_v3_deployment_deployments_cserve_v3_post**
> create_cserve_v3_deployment_deployments_cserve_v3_post()

Retired Cserve Deployment

### Example


```python
import platform_api_python_client
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)

    try:
        # Retired Cserve Deployment
        api_instance.create_cserve_v3_deployment_deployments_cserve_v3_post()
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_cserve_v3_deployment_deployments_cserve_v3_post: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**410** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_dynamo_deployment_deployments_dynamo_post**
> CreateDynamoDeploymentResponse create_dynamo_deployment_deployments_dynamo_post(create_dynamo_deployment_request)

Create Dynamo Deployment

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.create_dynamo_deployment_request import CreateDynamoDeploymentRequest
from platform_api_python_client.models.create_dynamo_deployment_response import CreateDynamoDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    create_dynamo_deployment_request = platform_api_python_client.CreateDynamoDeploymentRequest() # CreateDynamoDeploymentRequest | 

    try:
        # Create Dynamo Deployment
        api_response = api_instance.create_dynamo_deployment_deployments_dynamo_post(create_dynamo_deployment_request)
        print("The response of EXTERNALApi->create_dynamo_deployment_deployments_dynamo_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_dynamo_deployment_deployments_dynamo_post: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **create_dynamo_deployment_request** | [**CreateDynamoDeploymentRequest**](CreateDynamoDeploymentRequest.md)|  | 

### Return type

[**CreateDynamoDeploymentResponse**](CreateDynamoDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_hardware_instance_hardware_instances_post**
> HardwareInstanceResponse create_hardware_instance_hardware_instances_post(create_hardware_instance_request)

Create Hardware Instance

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.create_hardware_instance_request import CreateHardwareInstanceRequest
from platform_api_python_client.models.hardware_instance_response import HardwareInstanceResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    create_hardware_instance_request = platform_api_python_client.CreateHardwareInstanceRequest() # CreateHardwareInstanceRequest | 

    try:
        # Create Hardware Instance
        api_response = api_instance.create_hardware_instance_hardware_instances_post(create_hardware_instance_request)
        print("The response of EXTERNALApi->create_hardware_instance_hardware_instances_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_hardware_instance_hardware_instances_post: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **create_hardware_instance_request** | [**CreateHardwareInstanceRequest**](CreateHardwareInstanceRequest.md)|  | 

### Return type

[**HardwareInstanceResponse**](HardwareInstanceResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_inference_deployment_deployments_inference_post**
> CreateInferenceDeploymentResponse create_inference_deployment_deployments_inference_post()

Create Inference Deployment

### Example


```python
import platform_api_python_client
from platform_api_python_client.models.create_inference_deployment_response import CreateInferenceDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)

    try:
        # Create Inference Deployment
        api_response = api_instance.create_inference_deployment_deployments_inference_post()
        print("The response of EXTERNALApi->create_inference_deployment_deployments_inference_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_inference_deployment_deployments_inference_post: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

[**CreateInferenceDeploymentResponse**](CreateInferenceDeploymentResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_inference_v3_deployment_deployments_inference_v3_post**
> CreateInferenceDeploymentResponse create_inference_v3_deployment_deployments_inference_v3_post(create_inference_v3_deployment_request)

Create Inference V3 Deployment

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.create_inference_deployment_response import CreateInferenceDeploymentResponse
from platform_api_python_client.models.create_inference_v3_deployment_request import CreateInferenceV3DeploymentRequest
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    create_inference_v3_deployment_request = platform_api_python_client.CreateInferenceV3DeploymentRequest() # CreateInferenceV3DeploymentRequest | 

    try:
        # Create Inference V3 Deployment
        api_response = api_instance.create_inference_v3_deployment_deployments_inference_v3_post(create_inference_v3_deployment_request)
        print("The response of EXTERNALApi->create_inference_v3_deployment_deployments_inference_v3_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_inference_v3_deployment_deployments_inference_v3_post: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **create_inference_v3_deployment_request** | [**CreateInferenceV3DeploymentRequest**](CreateInferenceV3DeploymentRequest.md)|  | 

### Return type

[**CreateInferenceDeploymentResponse**](CreateInferenceDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_job_deployment_deployments_job_post**
> CreateJobDeploymentResponse create_job_deployment_deployments_job_post(create_job_deployment_request)

Create Job Deployment

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.create_job_deployment_request import CreateJobDeploymentRequest
from platform_api_python_client.models.create_job_deployment_response import CreateJobDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    create_job_deployment_request = platform_api_python_client.CreateJobDeploymentRequest() # CreateJobDeploymentRequest | 

    try:
        # Create Job Deployment
        api_response = api_instance.create_job_deployment_deployments_job_post(create_job_deployment_request)
        print("The response of EXTERNALApi->create_job_deployment_deployments_job_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_job_deployment_deployments_job_post: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **create_job_deployment_request** | [**CreateJobDeploymentRequest**](CreateJobDeploymentRequest.md)|  | 

### Return type

[**CreateJobDeploymentResponse**](CreateJobDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_new_organization_organizations_post**
> CreateOrganizationResponse create_new_organization_organizations_post(create_organization_request)

Create New Organization

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.create_organization_request import CreateOrganizationRequest
from platform_api_python_client.models.create_organization_response import CreateOrganizationResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    create_organization_request = platform_api_python_client.CreateOrganizationRequest() # CreateOrganizationRequest | 

    try:
        # Create New Organization
        api_response = api_instance.create_new_organization_organizations_post(create_organization_request)
        print("The response of EXTERNALApi->create_new_organization_organizations_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_new_organization_organizations_post: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **create_organization_request** | [**CreateOrganizationRequest**](CreateOrganizationRequest.md)|  | 

### Return type

[**CreateOrganizationResponse**](CreateOrganizationResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_service_account_service_accounts_post**
> CreateServiceAccountResponse create_service_account_service_accounts_post(create_service_account_request)

Create Service Account

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.create_service_account_request import CreateServiceAccountRequest
from platform_api_python_client.models.create_service_account_response import CreateServiceAccountResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    create_service_account_request = platform_api_python_client.CreateServiceAccountRequest() # CreateServiceAccountRequest | 

    try:
        # Create Service Account
        api_response = api_instance.create_service_account_service_accounts_post(create_service_account_request)
        print("The response of EXTERNALApi->create_service_account_service_accounts_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_service_account_service_accounts_post: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **create_service_account_request** | [**CreateServiceAccountRequest**](CreateServiceAccountRequest.md)|  | 

### Return type

[**CreateServiceAccountResponse**](CreateServiceAccountResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_unified_deployment_deployments_post**
> UnifiedWriteDeploymentResponse create_unified_deployment_deployments_post(unified_write_deployment_request)

Create Unified Deployment

Create a ccl_compute, ccl_inference, ccl_job or ccl_dynamo deployment through ccluster.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.unified_write_deployment_request import UnifiedWriteDeploymentRequest
from platform_api_python_client.models.unified_write_deployment_response import UnifiedWriteDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    unified_write_deployment_request = platform_api_python_client.UnifiedWriteDeploymentRequest() # UnifiedWriteDeploymentRequest | 

    try:
        # Create Unified Deployment
        api_response = api_instance.create_unified_deployment_deployments_post(unified_write_deployment_request)
        print("The response of EXTERNALApi->create_unified_deployment_deployments_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_unified_deployment_deployments_post: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **unified_write_deployment_request** | [**UnifiedWriteDeploymentRequest**](UnifiedWriteDeploymentRequest.md)|  | 

### Return type

[**UnifiedWriteDeploymentResponse**](UnifiedWriteDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_volume_endpoint_volumes_post**
> GetVolumeResponse create_volume_endpoint_volumes_post(create_volume_request)

Create Volume Endpoint

Create a filesystem or object volume.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.create_volume_request import CreateVolumeRequest
from platform_api_python_client.models.get_volume_response import GetVolumeResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    create_volume_request = platform_api_python_client.CreateVolumeRequest() # CreateVolumeRequest | 

    try:
        # Create Volume Endpoint
        api_response = api_instance.create_volume_endpoint_volumes_post(create_volume_request)
        print("The response of EXTERNALApi->create_volume_endpoint_volumes_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->create_volume_endpoint_volumes_post: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **create_volume_request** | [**CreateVolumeRequest**](CreateVolumeRequest.md)|  | 

### Return type

[**GetVolumeResponse**](GetVolumeResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_cluster_clusters_cluster_id_delete**
> object delete_cluster_clusters_cluster_id_delete(cluster_id)

Delete Cluster

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    cluster_id = 56 # int | 

    try:
        # Delete Cluster
        api_response = api_instance.delete_cluster_clusters_cluster_id_delete(cluster_id)
        print("The response of EXTERNALApi->delete_cluster_clusters_cluster_id_delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->delete_cluster_clusters_cluster_id_delete: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cluster_id** | **int**|  | 

### Return type

**object**

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_hardware_instance_hardware_instances_hardware_instance_id_delete**
> delete_hardware_instance_hardware_instances_hardware_instance_id_delete(hardware_instance_id)

Delete Hardware Instance

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    hardware_instance_id = 56 # int | 

    try:
        # Delete Hardware Instance
        api_instance.delete_hardware_instance_hardware_instances_hardware_instance_id_delete(hardware_instance_id)
    except Exception as e:
        print("Exception when calling EXTERNALApi->delete_hardware_instance_hardware_instances_hardware_instance_id_delete: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **hardware_instance_id** | **int**|  | 

### Return type

void (empty response body)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_service_account_service_accounts_workos_id_delete**
> delete_service_account_service_accounts_workos_id_delete(workos_id)

Delete Service Account

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    workos_id = 'workos_id_example' # str | 

    try:
        # Delete Service Account
        api_instance.delete_service_account_service_accounts_workos_id_delete(workos_id)
    except Exception as e:
        print("Exception when calling EXTERNALApi->delete_service_account_service_accounts_workos_id_delete: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **workos_id** | **str**|  | 

### Return type

void (empty response body)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_unified_deployment_deployments_deployment_id_delete**
> delete_unified_deployment_deployments_deployment_id_delete(deployment_id)

Delete Unified Deployment

Delete a deployment, as PUT /deployments/status/{deployment_id} with DELETED does.  Deletes ccl_compute, ccl_inference, ccl_job and ccl_dynamo deployments through ccluster, in any status.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 

    try:
        # Delete Unified Deployment
        api_instance.delete_unified_deployment_deployments_deployment_id_delete(deployment_id)
    except Exception as e:
        print("Exception when calling EXTERNALApi->delete_unified_deployment_deployments_deployment_id_delete: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 

### Return type

void (empty response body)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_user_vault_item_by_id_endpoint_user_vault_secret_id_delete**
> object delete_user_vault_item_by_id_endpoint_user_vault_secret_id_delete(secret_id)

Delete User Vault Item By Id Endpoint

Delete a vault item by ID. Returns 409 while a non-deleted deployment's selected revision references it.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    secret_id = 56 # int | 

    try:
        # Delete User Vault Item By Id Endpoint
        api_response = api_instance.delete_user_vault_item_by_id_endpoint_user_vault_secret_id_delete(secret_id)
        print("The response of EXTERNALApi->delete_user_vault_item_by_id_endpoint_user_vault_secret_id_delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->delete_user_vault_item_by_id_endpoint_user_vault_secret_id_delete: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **secret_id** | **int**|  | 

### Return type

**object**

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_user_vault_item_endpoint_user_vault_delete**
> object delete_user_vault_item_endpoint_user_vault_delete(delete_user_vault_item_request)

Delete User Vault Item Endpoint

Compatibility shim for the legacy type/key/visibility delete body.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.delete_user_vault_item_request import DeleteUserVaultItemRequest
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    delete_user_vault_item_request = platform_api_python_client.DeleteUserVaultItemRequest() # DeleteUserVaultItemRequest | 

    try:
        # Delete User Vault Item Endpoint
        api_response = api_instance.delete_user_vault_item_endpoint_user_vault_delete(delete_user_vault_item_request)
        print("The response of EXTERNALApi->delete_user_vault_item_endpoint_user_vault_delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->delete_user_vault_item_endpoint_user_vault_delete: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **delete_user_vault_item_request** | [**DeleteUserVaultItemRequest**](DeleteUserVaultItemRequest.md)|  | 

### Return type

**object**

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **delete_volume_endpoint_volumes_volume_id_delete**
> object delete_volume_endpoint_volumes_volume_id_delete(volume_id)

Delete Volume Endpoint

Delete a volume: tear down its ArgoCD app (and PVC) if reachable, then soft-delete the row. Only the owner or an admin with admin:manage_volumes may delete.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    volume_id = 56 # int | 

    try:
        # Delete Volume Endpoint
        api_response = api_instance.delete_volume_endpoint_volumes_volume_id_delete(volume_id)
        print("The response of EXTERNALApi->delete_volume_endpoint_volumes_volume_id_delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->delete_volume_endpoint_volumes_volume_id_delete: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **volume_id** | **int**|  | 

### Return type

**object**

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **generate_service_account_secret_service_accounts_workos_id_secrets_post**
> GenerateServiceAccountSecretResponse generate_service_account_secret_service_accounts_workos_id_secrets_post(workos_id)

Generate Service Account Secret

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.generate_service_account_secret_response import GenerateServiceAccountSecretResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    workos_id = 'workos_id_example' # str | 

    try:
        # Generate Service Account Secret
        api_response = api_instance.generate_service_account_secret_service_accounts_workos_id_secrets_post(workos_id)
        print("The response of EXTERNALApi->generate_service_account_secret_service_accounts_workos_id_secrets_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->generate_service_account_secret_service_accounts_workos_id_secrets_post: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **workos_id** | **str**|  | 

### Return type

[**GenerateServiceAccountSecretResponse**](GenerateServiceAccountSecretResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_all_user_vault_items_endpoint_user_vault_get**
> ListUserVaultItemsResponse get_all_user_vault_items_endpoint_user_vault_get(type=type, search_query=search_query)

Get All User Vault Items Endpoint

List metadata for every item the user can read, without any secret values.  Values are deliberately omitted so browsing the vault never bulk-exposes secrets. Callers that need one value fetch it from the by-id endpoint below.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.list_user_vault_items_response import ListUserVaultItemsResponse
from platform_api_python_client.models.user_vault_type import UserVaultType
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    type = platform_api_python_client.UserVaultType() # UserVaultType |  (optional)
    search_query = 'search_query_example' # str |  (optional)

    try:
        # Get All User Vault Items Endpoint
        api_response = api_instance.get_all_user_vault_items_endpoint_user_vault_get(type=type, search_query=search_query)
        print("The response of EXTERNALApi->get_all_user_vault_items_endpoint_user_vault_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_all_user_vault_items_endpoint_user_vault_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **type** | [**UserVaultType**](.md)|  | [optional] 
 **search_query** | **str**|  | [optional] 

### Return type

[**ListUserVaultItemsResponse**](ListUserVaultItemsResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_all_volumes_endpoint_volumes_get**
> ListVolumesResponse get_all_volumes_endpoint_volumes_get()

Get All Volumes Endpoint

Retrieve all of the organization's volumes.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.list_volumes_response import ListVolumesResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)

    try:
        # Get All Volumes Endpoint
        api_response = api_instance.get_all_volumes_endpoint_volumes_get()
        print("The response of EXTERNALApi->get_all_volumes_endpoint_volumes_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_all_volumes_endpoint_volumes_get: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

[**ListVolumesResponse**](ListVolumesResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_clusters_clusters_get**
> ListGetClusterResponse get_clusters_clusters_get()

Get Clusters

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.list_get_cluster_response import ListGetClusterResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)

    try:
        # Get Clusters
        api_response = api_instance.get_clusters_clusters_get()
        print("The response of EXTERNALApi->get_clusters_clusters_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_clusters_clusters_get: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

[**ListGetClusterResponse**](ListGetClusterResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_compute_deployment_deployments_compute_deployment_id_get**
> GetComputeDeploymentResponse get_compute_deployment_deployments_compute_deployment_id_get(deployment_id)

Get Compute Deployment

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.get_compute_deployment_response import GetComputeDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 

    try:
        # Get Compute Deployment
        api_response = api_instance.get_compute_deployment_deployments_compute_deployment_id_get(deployment_id)
        print("The response of EXTERNALApi->get_compute_deployment_deployments_compute_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_compute_deployment_deployments_compute_deployment_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 

### Return type

[**GetComputeDeploymentResponse**](GetComputeDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_credits_credits_get**
> CreditsResponse get_credits_credits_get()

Get Credits

### Example


```python
import platform_api_python_client
from platform_api_python_client.models.credits_response import CreditsResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)

    try:
        # Get Credits
        api_response = api_instance.get_credits_credits_get()
        print("The response of EXTERNALApi->get_credits_credits_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_credits_credits_get: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

[**CreditsResponse**](CreditsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_cserve_deployment_deployments_cserve_deployment_id_get**
> get_cserve_deployment_deployments_cserve_deployment_id_get(deployment_id)

Retired Cserve Deployment Detail

### Example


```python
import platform_api_python_client
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 

    try:
        # Retired Cserve Deployment Detail
        api_instance.get_cserve_deployment_deployments_cserve_deployment_id_get(deployment_id)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_cserve_deployment_deployments_cserve_deployment_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**410** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_cserve_v2_deployment_deployments_cserve_v2_deployment_id_get**
> get_cserve_v2_deployment_deployments_cserve_v2_deployment_id_get(deployment_id)

Retired Cserve Deployment Detail

### Example


```python
import platform_api_python_client
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 

    try:
        # Retired Cserve Deployment Detail
        api_instance.get_cserve_v2_deployment_deployments_cserve_v2_deployment_id_get(deployment_id)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_cserve_v2_deployment_deployments_cserve_v2_deployment_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**410** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_cserve_v3_deployment_deployments_cserve_v3_deployment_id_get**
> get_cserve_v3_deployment_deployments_cserve_v3_deployment_id_get(deployment_id)

Retired Cserve Deployment Detail

### Example


```python
import platform_api_python_client
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 

    try:
        # Retired Cserve Deployment Detail
        api_instance.get_cserve_v3_deployment_deployments_cserve_v3_deployment_id_get(deployment_id)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_cserve_v3_deployment_deployments_cserve_v3_deployment_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**410** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_current_org_gpu_quota_organizations_gpu_quota_get**
> ListOrganizationGpuQuotaResponse get_current_org_gpu_quota_organizations_gpu_quota_get(cluster_id=cluster_id)

Get Current Org Gpu Quota

Return persisted GPU quotas for the caller's organization. Usage fields come later.  ``cluster_id`` filters to that cluster when it is visible. Unknown or invisible cluster IDs return an empty list rather than 404 so this member endpoint does not leak whether a cluster exists.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.list_organization_gpu_quota_response import ListOrganizationGpuQuotaResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    cluster_id = 56 # int |  (optional)

    try:
        # Get Current Org Gpu Quota
        api_response = api_instance.get_current_org_gpu_quota_organizations_gpu_quota_get(cluster_id=cluster_id)
        print("The response of EXTERNALApi->get_current_org_gpu_quota_organizations_gpu_quota_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_current_org_gpu_quota_organizations_gpu_quota_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cluster_id** | **int**|  | [optional] 

### Return type

[**ListOrganizationGpuQuotaResponse**](ListOrganizationGpuQuotaResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_deployment_logs_deployments_logs_deployment_id_get**
> GetDeploymentLogResponse get_deployment_logs_deployments_logs_deployment_id_get(deployment_id, start_time, end_time, next_page_token=next_page_token, start_from_head=start_from_head, line_count=line_count)

Get Deployment Logs

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.get_deployment_log_response import GetDeploymentLogResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    start_time = 56 # int | 
    end_time = 56 # int | 
    next_page_token = 'next_page_token_example' # str |  (optional)
    start_from_head = True # bool |  (optional) (default to True)
    line_count = 56 # int |  (optional)

    try:
        # Get Deployment Logs
        api_response = api_instance.get_deployment_logs_deployments_logs_deployment_id_get(deployment_id, start_time, end_time, next_page_token=next_page_token, start_from_head=start_from_head, line_count=line_count)
        print("The response of EXTERNALApi->get_deployment_logs_deployments_logs_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_deployment_logs_deployments_logs_deployment_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **start_time** | **int**|  | 
 **end_time** | **int**|  | 
 **next_page_token** | **str**|  | [optional] 
 **start_from_head** | **bool**|  | [optional] [default to True]
 **line_count** | **int**|  | [optional] 

### Return type

[**GetDeploymentLogResponse**](GetDeploymentLogResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_deployment_logs_v3_deployments_logs_v3_deployment_id_revision_number_get**
> GetDeploymentLogResponse get_deployment_logs_v3_deployments_logs_v3_deployment_id_revision_number_get(deployment_id, revision_number, start_time, end_time, next_page_token=next_page_token, start_from_head=start_from_head, line_count=line_count)

Get Deployment Logs V3

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.get_deployment_log_response import GetDeploymentLogResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    revision_number = 56 # int | 
    start_time = 56 # int | 
    end_time = 56 # int | 
    next_page_token = 'next_page_token_example' # str |  (optional)
    start_from_head = True # bool |  (optional) (default to True)
    line_count = 56 # int |  (optional)

    try:
        # Get Deployment Logs V3
        api_response = api_instance.get_deployment_logs_v3_deployments_logs_v3_deployment_id_revision_number_get(deployment_id, revision_number, start_time, end_time, next_page_token=next_page_token, start_from_head=start_from_head, line_count=line_count)
        print("The response of EXTERNALApi->get_deployment_logs_v3_deployments_logs_v3_deployment_id_revision_number_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_deployment_logs_v3_deployments_logs_v3_deployment_id_revision_number_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **revision_number** | **int**|  | 
 **start_time** | **int**|  | 
 **end_time** | **int**|  | 
 **next_page_token** | **str**|  | [optional] 
 **start_from_head** | **bool**|  | [optional] [default to True]
 **line_count** | **int**|  | [optional] 

### Return type

[**GetDeploymentLogResponse**](GetDeploymentLogResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_deployment_logs_v4_logs_deployment_id_revision_number_get**
> GetDeploymentLogV4Response get_deployment_logs_v4_logs_deployment_id_revision_number_get(deployment_id, revision_number, pod, fetch_newer=fetch_newer, timestamp=timestamp, max_lines=max_lines)

Get Deployment Logs V4

Retrieve one page of a single pod's logs from Loki, oldest line first.  - `pod`: which pod's logs to read; pick a name reported by   `/deployments/pods/{deployment_id}/{revision_number}` — a pod unknown to the log store   simply yields empty pages. - `fetch_newer`: direction. `false` (default) pages toward older logs, starting from the   newest page; `true` fetches newer logs (for follow-polling). - `timestamp`: epoch-millisecond boundary (the events' `timestamp` unit), exclusive in both   directions: `fetch_newer=false` returns lines strictly older than that millisecond,   `fetch_newer=true` lines strictly newer. Without it both directions scan the whole log   window: `fetch_newer=false` starts at the tail (the newest page), `fetch_newer=true` at   the head (the oldest page) — to follow live logs, take the tail page first and pass its   newest `timestamp`. There is no server-issued page token — mint the boundary from the   events themselves (pages never split a millisecond, so a delivered boundary millisecond   is always complete): pass the oldest event's `timestamp` to keep paging older, and the   newest event `timestamp` seen on any page — history pages included — to fetch newer. An   empty `fetch_newer=false` page means history is exhausted; an empty `fetch_newer=true`   page means nothing new yet — poll again with the same `timestamp`. - `fetch_newer=true` with a `timestamp` also re-delivers the ~15 seconds at and before it on   every poll (late-arriving lines land there), so callers must deduplicate by event `id`;   re-delivered lines do not count toward `max_lines`. A span holding more than the log   store's 5000-entry query ceiling re-delivers only its newest 5000 lines (the excess is   dropped and logged server-side). - `max_lines`: cap on new lines per page — default 100, at most 5000 (the log store's   per-query ceiling); a page may exceed it when many lines share one millisecond (such a   group is never split across pages, unless it exceeds that same 5000-entry ceiling — the   excess is then dropped and logged server-side) or through the re-delivered span.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.get_deployment_log_v4_response import GetDeploymentLogV4Response
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    revision_number = 56 # int | 
    pod = 'pod_example' # str | 
    fetch_newer = False # bool |  (optional) (default to False)
    timestamp = 56 # int |  (optional)
    max_lines = 100 # int |  (optional) (default to 100)

    try:
        # Get Deployment Logs V4
        api_response = api_instance.get_deployment_logs_v4_logs_deployment_id_revision_number_get(deployment_id, revision_number, pod, fetch_newer=fetch_newer, timestamp=timestamp, max_lines=max_lines)
        print("The response of EXTERNALApi->get_deployment_logs_v4_logs_deployment_id_revision_number_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_deployment_logs_v4_logs_deployment_id_revision_number_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **revision_number** | **int**|  | 
 **pod** | **str**|  | 
 **fetch_newer** | **bool**|  | [optional] [default to False]
 **timestamp** | **int**|  | [optional] 
 **max_lines** | **int**|  | [optional] [default to 100]

### Return type

[**GetDeploymentLogV4Response**](GetDeploymentLogV4Response.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_deployment_pods_deployments_pods_deployment_id_revision_number_get**
> GetDeploymentPodsResponse get_deployment_pods_deployments_pods_deployment_id_revision_number_get(deployment_id, revision_number)

Get Deployment Pods

List the pod names recorded for this revision, recently terminated pods included; the history is bounded to a retention window, so the list can differ from the live pods in status_v3.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.get_deployment_pods_response import GetDeploymentPodsResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    revision_number = 56 # int | 

    try:
        # Get Deployment Pods
        api_response = api_instance.get_deployment_pods_deployments_pods_deployment_id_revision_number_get(deployment_id, revision_number)
        print("The response of EXTERNALApi->get_deployment_pods_deployments_pods_deployment_id_revision_number_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_deployment_pods_deployments_pods_deployment_id_revision_number_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **revision_number** | **int**|  | 

### Return type

[**GetDeploymentPodsResponse**](GetDeploymentPodsResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_deployment_revision_deployments_revisions_deployment_id_revision_number_get**
> GetDeploymentRevisionResponse get_deployment_revision_deployments_revisions_deployment_id_revision_number_get(deployment_id, revision_number)

Get Deployment Revision

Get a specific revision for a deployment.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.get_deployment_revision_response import GetDeploymentRevisionResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    revision_number = 56 # int | 

    try:
        # Get Deployment Revision
        api_response = api_instance.get_deployment_revision_deployments_revisions_deployment_id_revision_number_get(deployment_id, revision_number)
        print("The response of EXTERNALApi->get_deployment_revision_deployments_revisions_deployment_id_revision_number_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_deployment_revision_deployments_revisions_deployment_id_revision_number_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **revision_number** | **int**|  | 

### Return type

[**GetDeploymentRevisionResponse**](GetDeploymentRevisionResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_deployment_revisions_deployments_revisions_deployment_id_get**
> ListDeploymentRevisionsResponse get_deployment_revisions_deployments_revisions_deployment_id_get(deployment_id)

Get Deployment Revisions

List all revisions for a deployment.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.list_deployment_revisions_response import ListDeploymentRevisionsResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 

    try:
        # Get Deployment Revisions
        api_response = api_instance.get_deployment_revisions_deployments_revisions_deployment_id_get(deployment_id)
        print("The response of EXTERNALApi->get_deployment_revisions_deployments_revisions_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_deployment_revisions_deployments_revisions_deployment_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 

### Return type

[**ListDeploymentRevisionsResponse**](ListDeploymentRevisionsResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_deployment_status_deployments_status_deployment_id_get**
> DeploymentStatusResponse get_deployment_status_deployments_status_deployment_id_get(deployment_id)

Get Deployment Status

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.deployment_status_response import DeploymentStatusResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 

    try:
        # Get Deployment Status
        api_response = api_instance.get_deployment_status_deployments_status_deployment_id_get(deployment_id)
        print("The response of EXTERNALApi->get_deployment_status_deployments_status_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_deployment_status_deployments_status_deployment_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 

### Return type

[**DeploymentStatusResponse**](DeploymentStatusResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_deployment_status_v3_deployments_status_v3_deployment_id_get**
> DeploymentStatusV3Response get_deployment_status_v3_deployments_status_v3_deployment_id_get(deployment_id)

Get Deployment Status V3

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.deployment_status_v3_response import DeploymentStatusV3Response
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 

    try:
        # Get Deployment Status V3
        api_response = api_instance.get_deployment_status_v3_deployments_status_v3_deployment_id_get(deployment_id)
        print("The response of EXTERNALApi->get_deployment_status_v3_deployments_status_v3_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_deployment_status_v3_deployments_status_v3_deployment_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 

### Return type

[**DeploymentStatusV3Response**](DeploymentStatusV3Response.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_deployments_deployments_get**
> ListGetDeploymentResponse get_deployments_deployments_get(offset=offset, limit=limit, type=type, search_query=search_query)

Get Deployments

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.deployment_type import DeploymentType
from platform_api_python_client.models.list_get_deployment_response import ListGetDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    offset = 56 # int |  (optional)
    limit = 56 # int |  (optional)
    type = platform_api_python_client.DeploymentType() # DeploymentType |  (optional)
    search_query = 'search_query_example' # str |  (optional)

    try:
        # Get Deployments
        api_response = api_instance.get_deployments_deployments_get(offset=offset, limit=limit, type=type, search_query=search_query)
        print("The response of EXTERNALApi->get_deployments_deployments_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_deployments_deployments_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **offset** | **int**|  | [optional] 
 **limit** | **int**|  | [optional] 
 **type** | [**DeploymentType**](.md)|  | [optional] 
 **search_query** | **str**|  | [optional] 

### Return type

[**ListGetDeploymentResponse**](ListGetDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_dynamo_deployment_deployments_dynamo_deployment_id_get**
> GetDynamoDeploymentResponse get_dynamo_deployment_deployments_dynamo_deployment_id_get(deployment_id)

Get Dynamo Deployment

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.get_dynamo_deployment_response import GetDynamoDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 

    try:
        # Get Dynamo Deployment
        api_response = api_instance.get_dynamo_deployment_deployments_dynamo_deployment_id_get(deployment_id)
        print("The response of EXTERNALApi->get_dynamo_deployment_deployments_dynamo_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_dynamo_deployment_deployments_dynamo_deployment_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 

### Return type

[**GetDynamoDeploymentResponse**](GetDynamoDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_hardware_instances_hardware_instances_get**
> ListHardwareInstanceResponse get_hardware_instances_hardware_instances_get(cluster_id=cluster_id)

Get Hardware Instances

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.list_hardware_instance_response import ListHardwareInstanceResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    cluster_id = 56 # int |  (optional)

    try:
        # Get Hardware Instances
        api_response = api_instance.get_hardware_instances_hardware_instances_get(cluster_id=cluster_id)
        print("The response of EXTERNALApi->get_hardware_instances_hardware_instances_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_hardware_instances_hardware_instances_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cluster_id** | **int**|  | [optional] 

### Return type

[**ListHardwareInstanceResponse**](ListHardwareInstanceResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_hardware_presets_hardware_instances_presets_get**
> ListHardwarePresetResponse get_hardware_presets_hardware_instances_presets_get()

Get Hardware Presets

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.list_hardware_preset_response import ListHardwarePresetResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)

    try:
        # Get Hardware Presets
        api_response = api_instance.get_hardware_presets_hardware_instances_presets_get()
        print("The response of EXTERNALApi->get_hardware_presets_hardware_instances_presets_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_hardware_presets_hardware_instances_presets_get: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

[**ListHardwarePresetResponse**](ListHardwarePresetResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_inference_deployment_deployments_inference_deployment_id_get**
> GetInferenceDeploymentResponse get_inference_deployment_deployments_inference_deployment_id_get(deployment_id)

Get Inference Deployment

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.get_inference_deployment_response import GetInferenceDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 

    try:
        # Get Inference Deployment
        api_response = api_instance.get_inference_deployment_deployments_inference_deployment_id_get(deployment_id)
        print("The response of EXTERNALApi->get_inference_deployment_deployments_inference_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_inference_deployment_deployments_inference_deployment_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 

### Return type

[**GetInferenceDeploymentResponse**](GetInferenceDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_inference_v3_deployment_deployments_inference_v3_deployment_id_get**
> GetInferenceV3DeploymentResponse get_inference_v3_deployment_deployments_inference_v3_deployment_id_get(deployment_id)

Get Inference V3 Deployment

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.get_inference_v3_deployment_response import GetInferenceV3DeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 

    try:
        # Get Inference V3 Deployment
        api_response = api_instance.get_inference_v3_deployment_deployments_inference_v3_deployment_id_get(deployment_id)
        print("The response of EXTERNALApi->get_inference_v3_deployment_deployments_inference_v3_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_inference_v3_deployment_deployments_inference_v3_deployment_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 

### Return type

[**GetInferenceV3DeploymentResponse**](GetInferenceV3DeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_insight_insights_insight_id_get**
> InsightResponse get_insight_insights_insight_id_get(insight_id)

Get Insight

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.insight_response import InsightResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    insight_id = 56 # int | 

    try:
        # Get Insight
        api_response = api_instance.get_insight_insights_insight_id_get(insight_id)
        print("The response of EXTERNALApi->get_insight_insights_insight_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_insight_insights_insight_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **insight_id** | **int**|  | 

### Return type

[**InsightResponse**](InsightResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_job_deployment_deployments_job_deployment_id_get**
> GetJobDeploymentResponse get_job_deployment_deployments_job_deployment_id_get(deployment_id)

Get Job Deployment

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.get_job_deployment_response import GetJobDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 

    try:
        # Get Job Deployment
        api_response = api_instance.get_job_deployment_deployments_job_deployment_id_get(deployment_id)
        print("The response of EXTERNALApi->get_job_deployment_deployments_job_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_job_deployment_deployments_job_deployment_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 

### Return type

[**GetJobDeploymentResponse**](GetJobDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_get**
> OrganizationGpuQuotaResponse get_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_get(cluster_id, organization_id)

Get Org Gpu Quota On Cluster

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.organization_gpu_quota_response import OrganizationGpuQuotaResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    cluster_id = 56 # int | 
    organization_id = 56 # int | 

    try:
        # Get Org Gpu Quota On Cluster
        api_response = api_instance.get_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_get(cluster_id, organization_id)
        print("The response of EXTERNALApi->get_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cluster_id** | **int**|  | 
 **organization_id** | **int**|  | 

### Return type

[**OrganizationGpuQuotaResponse**](OrganizationGpuQuotaResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_prebuilt_images_prebuilt_images_get**
> ListPrebuiltImageResponse get_prebuilt_images_prebuilt_images_get(type=type)

Get Prebuilt Images

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.deployment_type import DeploymentType
from platform_api_python_client.models.list_prebuilt_image_response import ListPrebuiltImageResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    type = platform_api_python_client.DeploymentType() # DeploymentType |  (optional)

    try:
        # Get Prebuilt Images
        api_response = api_instance.get_prebuilt_images_prebuilt_images_get(type=type)
        print("The response of EXTERNALApi->get_prebuilt_images_prebuilt_images_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_prebuilt_images_prebuilt_images_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **type** | [**DeploymentType**](.md)|  | [optional] 

### Return type

[**ListPrebuiltImageResponse**](ListPrebuiltImageResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_unified_deployment_deployments_deployment_id_get**
> UnifiedGetDeploymentResponse get_unified_deployment_deployments_deployment_id_get(deployment_id)

Get Unified Deployment

Get a ccl_compute, ccl_inference, ccl_job or ccl_dynamo deployment: its request and its read-only fields.  env.vars values are masked unless the caller owns the deployment or may manage the organization's deployments.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.unified_get_deployment_response import UnifiedGetDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 

    try:
        # Get Unified Deployment
        api_response = api_instance.get_unified_deployment_deployments_deployment_id_get(deployment_id)
        print("The response of EXTERNALApi->get_unified_deployment_deployments_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_unified_deployment_deployments_deployment_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 

### Return type

[**UnifiedGetDeploymentResponse**](UnifiedGetDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_unified_deployment_logs_deployments_deployment_id_revisions_revision_number_logs_get**
> UnifiedGetDeploymentLogsResponse get_unified_deployment_logs_deployments_deployment_id_revisions_revision_number_logs_get(deployment_id, revision_number, pod, fetch_newer=fetch_newer, timestamp=timestamp, max_lines=max_lines)

Get Unified Deployment Logs

Read one page of a pod's logs from Loki, with the paging of GET /logs/{deployment_id}/{revision_number}.  Take the pod from GET /deployments/{deployment_id}/revisions/{revision_number}/pods.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.unified_get_deployment_logs_response import UnifiedGetDeploymentLogsResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    revision_number = 56 # int | 
    pod = 'pod_example' # str | 
    fetch_newer = False # bool |  (optional) (default to False)
    timestamp = 56 # int |  (optional)
    max_lines = 100 # int |  (optional) (default to 100)

    try:
        # Get Unified Deployment Logs
        api_response = api_instance.get_unified_deployment_logs_deployments_deployment_id_revisions_revision_number_logs_get(deployment_id, revision_number, pod, fetch_newer=fetch_newer, timestamp=timestamp, max_lines=max_lines)
        print("The response of EXTERNALApi->get_unified_deployment_logs_deployments_deployment_id_revisions_revision_number_logs_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_unified_deployment_logs_deployments_deployment_id_revisions_revision_number_logs_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **revision_number** | **int**|  | 
 **pod** | **str**|  | 
 **fetch_newer** | **bool**|  | [optional] [default to False]
 **timestamp** | **int**|  | [optional] 
 **max_lines** | **int**|  | [optional] [default to 100]

### Return type

[**UnifiedGetDeploymentLogsResponse**](UnifiedGetDeploymentLogsResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_unified_deployment_pods_deployments_deployment_id_revisions_revision_number_pods_get**
> UnifiedGetDeploymentPodsResponse get_unified_deployment_pods_deployments_deployment_id_revisions_revision_number_pods_get(deployment_id, revision_number)

Get Unified Deployment Pods

List the pods that logged under one revision, recently terminated pods included. The log store's retention bounds the history, so the list can differ from the running pods.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.unified_get_deployment_pods_response import UnifiedGetDeploymentPodsResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    revision_number = 56 # int | 

    try:
        # Get Unified Deployment Pods
        api_response = api_instance.get_unified_deployment_pods_deployments_deployment_id_revisions_revision_number_pods_get(deployment_id, revision_number)
        print("The response of EXTERNALApi->get_unified_deployment_pods_deployments_deployment_id_revisions_revision_number_pods_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_unified_deployment_pods_deployments_deployment_id_revisions_revision_number_pods_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **revision_number** | **int**|  | 

### Return type

[**UnifiedGetDeploymentPodsResponse**](UnifiedGetDeploymentPodsResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_get**
> UnifiedGetDeploymentRevisionResponse get_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_get(deployment_id, revision_number)

Get Unified Deployment Revision

Get one revision of a deployment, read as GET /deployments/{deployment_id} reads the selected one.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.unified_get_deployment_revision_response import UnifiedGetDeploymentRevisionResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    revision_number = 56 # int | 

    try:
        # Get Unified Deployment Revision
        api_response = api_instance.get_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_get(deployment_id, revision_number)
        print("The response of EXTERNALApi->get_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **revision_number** | **int**|  | 

### Return type

[**UnifiedGetDeploymentRevisionResponse**](UnifiedGetDeploymentRevisionResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_unified_deployment_rollout_deployments_deployment_id_rollout_get**
> UnifiedGetDeploymentRolloutResponse get_unified_deployment_rollout_deployments_deployment_id_rollout_get(deployment_id)

Get Unified Deployment Rollout

Get whether the in-flight rollout is paused, and its status. Not implemented yet.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.unified_get_deployment_rollout_response import UnifiedGetDeploymentRolloutResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 

    try:
        # Get Unified Deployment Rollout
        api_response = api_instance.get_unified_deployment_rollout_deployments_deployment_id_rollout_get(deployment_id)
        print("The response of EXTERNALApi->get_unified_deployment_rollout_deployments_deployment_id_rollout_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_unified_deployment_rollout_deployments_deployment_id_rollout_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 

### Return type

[**UnifiedGetDeploymentRolloutResponse**](UnifiedGetDeploymentRolloutResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_unified_deployment_usage_deployments_deployment_id_usage_get**
> UnifiedGetDeploymentUsageResponse get_unified_deployment_usage_deployments_deployment_id_usage_get(deployment_id, metric, start_time_in_seconds, end_time_in_seconds, step=step, revision_number=revision_number, component=component, pod=pod)

Get Unified Deployment Usage

Read a deployment's usage metrics, as GET /deployments/usage/{deployment_id} does.  ccl_dynamo takes cpu, memory, gpu and gpu_memory with the component, revision_number and pod filters, as dynamo does; its dynamo_* metrics are not supported yet.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.metric import Metric
from platform_api_python_client.models.unified_get_deployment_usage_response import UnifiedGetDeploymentUsageResponse
from platform_api_python_client.models.usage_component import UsageComponent
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    metric = platform_api_python_client.Metric() # Metric | 
    start_time_in_seconds = 56 # int | 
    end_time_in_seconds = 56 # int | 
    step = 15 # int |  (optional) (default to 15)
    revision_number = 56 # int |  (optional)
    component = platform_api_python_client.UsageComponent() # UsageComponent |  (optional)
    pod = 'pod_example' # str |  (optional)

    try:
        # Get Unified Deployment Usage
        api_response = api_instance.get_unified_deployment_usage_deployments_deployment_id_usage_get(deployment_id, metric, start_time_in_seconds, end_time_in_seconds, step=step, revision_number=revision_number, component=component, pod=pod)
        print("The response of EXTERNALApi->get_unified_deployment_usage_deployments_deployment_id_usage_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_unified_deployment_usage_deployments_deployment_id_usage_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **metric** | [**Metric**](.md)|  | 
 **start_time_in_seconds** | **int**|  | 
 **end_time_in_seconds** | **int**|  | 
 **step** | **int**|  | [optional] [default to 15]
 **revision_number** | **int**|  | [optional] 
 **component** | [**UsageComponent**](.md)|  | [optional] 
 **pod** | **str**|  | [optional] 

### Return type

[**UnifiedGetDeploymentUsageResponse**](UnifiedGetDeploymentUsageResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_usage_daily_bills_get**
> ListDailyBillResponse get_usage_daily_bills_get()

Get Usage

### Example


```python
import platform_api_python_client
from platform_api_python_client.models.list_daily_bill_response import ListDailyBillResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)

    try:
        # Get Usage
        api_response = api_instance.get_usage_daily_bills_get()
        print("The response of EXTERNALApi->get_usage_daily_bills_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_usage_daily_bills_get: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

[**ListDailyBillResponse**](ListDailyBillResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_usage_deployments_usage_deployment_id_get**
> GetDeploymentUsageResponse get_usage_deployments_usage_deployment_id_get(deployment_id, metric, start_time_in_seconds, end_time_in_seconds, step=step, revision_number=revision_number, component=component, pod=pod)

Get Usage

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.get_deployment_usage_response import GetDeploymentUsageResponse
from platform_api_python_client.models.metric import Metric
from platform_api_python_client.models.usage_component import UsageComponent
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    metric = platform_api_python_client.Metric() # Metric | 
    start_time_in_seconds = 56 # int | 
    end_time_in_seconds = 56 # int | 
    step = 15 # int |  (optional) (default to 15)
    revision_number = 56 # int |  (optional)
    component = platform_api_python_client.UsageComponent() # UsageComponent |  (optional)
    pod = 'pod_example' # str |  (optional)

    try:
        # Get Usage
        api_response = api_instance.get_usage_deployments_usage_deployment_id_get(deployment_id, metric, start_time_in_seconds, end_time_in_seconds, step=step, revision_number=revision_number, component=component, pod=pod)
        print("The response of EXTERNALApi->get_usage_deployments_usage_deployment_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_usage_deployments_usage_deployment_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **metric** | [**Metric**](.md)|  | 
 **start_time_in_seconds** | **int**|  | 
 **end_time_in_seconds** | **int**|  | 
 **step** | **int**|  | [optional] [default to 15]
 **revision_number** | **int**|  | [optional] 
 **component** | [**UsageComponent**](.md)|  | [optional] 
 **pod** | **str**|  | [optional] 

### Return type

[**GetDeploymentUsageResponse**](GetDeploymentUsageResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_user_vault_item_by_id_endpoint_user_vault_secret_id_get**
> UserVaultItem get_user_vault_item_by_id_endpoint_user_vault_secret_id_get(secret_id)

Get User Vault Item By Id Endpoint

Resolve a single secret's value.  This is the only endpoint that returns a vault value, so it is the single place where read access to secret material is authorized and auditable.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.user_vault_item import UserVaultItem
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    secret_id = 56 # int | 

    try:
        # Get User Vault Item By Id Endpoint
        api_response = api_instance.get_user_vault_item_by_id_endpoint_user_vault_secret_id_get(secret_id)
        print("The response of EXTERNALApi->get_user_vault_item_by_id_endpoint_user_vault_secret_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_user_vault_item_by_id_endpoint_user_vault_secret_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **secret_id** | **int**|  | 

### Return type

[**UserVaultItem**](UserVaultItem.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_volume_endpoint_volumes_volume_id_get**
> GetVolumeResponse get_volume_endpoint_volumes_volume_id_get(volume_id)

Get Volume Endpoint

Retrieve a single volume by id.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.get_volume_response import GetVolumeResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    volume_id = 56 # int | 

    try:
        # Get Volume Endpoint
        api_response = api_instance.get_volume_endpoint_volumes_volume_id_get(volume_id)
        print("The response of EXTERNALApi->get_volume_endpoint_volumes_volume_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_volume_endpoint_volumes_volume_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **volume_id** | **int**|  | 

### Return type

[**GetVolumeResponse**](GetVolumeResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_volume_status_endpoint_volumes_status_volume_id_get**
> VolumeStatusResponse get_volume_status_endpoint_volumes_status_volume_id_get(volume_id)

Get Volume Status Endpoint

Live volume status: status is the stored intent, service_status is computed from the volume app's health and PVC phase.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.volume_status_response import VolumeStatusResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    volume_id = 56 # int | 

    try:
        # Get Volume Status Endpoint
        api_response = api_instance.get_volume_status_endpoint_volumes_status_volume_id_get(volume_id)
        print("The response of EXTERNALApi->get_volume_status_endpoint_volumes_status_volume_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->get_volume_status_endpoint_volumes_status_volume_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **volume_id** | **int**|  | 

### Return type

[**VolumeStatusResponse**](VolumeStatusResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **invite_user_organizations_invite_post**
> object invite_user_organizations_invite_post(invite_user_request)

Invite User

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.invite_user_request import InviteUserRequest
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    invite_user_request = platform_api_python_client.InviteUserRequest() # InviteUserRequest | 

    try:
        # Invite User
        api_response = api_instance.invite_user_organizations_invite_post(invite_user_request)
        print("The response of EXTERNALApi->invite_user_organizations_invite_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->invite_user_organizations_invite_post: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **invite_user_request** | [**InviteUserRequest**](InviteUserRequest.md)|  | 

### Return type

**object**

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_cluster_capacity_capacity_get**
> ListClusterCapacityResponse list_cluster_capacity_capacity_get(cluster_id=cluster_id)

List Cluster Capacity

Return GPU capacity breakdown for accessible clusters.  When *cluster_id* is supplied only that cluster is included (if accessible).  Clusters whose Prometheus data is unavailable are omitted from the results rather than failing the entire request.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.list_cluster_capacity_response import ListClusterCapacityResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    cluster_id = 56 # int |  (optional)

    try:
        # List Cluster Capacity
        api_response = api_instance.list_cluster_capacity_capacity_get(cluster_id=cluster_id)
        print("The response of EXTERNALApi->list_cluster_capacity_capacity_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->list_cluster_capacity_capacity_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cluster_id** | **int**|  | [optional] 

### Return type

[**ListClusterCapacityResponse**](ListClusterCapacityResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_cluster_org_gpu_quotas_clusters_cluster_id_gpu_quota_organizations_get**
> ListOrganizationGpuQuotaResponse list_cluster_org_gpu_quotas_clusters_cluster_id_gpu_quota_organizations_get(cluster_id)

List Cluster Org Gpu Quotas

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.list_organization_gpu_quota_response import ListOrganizationGpuQuotaResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    cluster_id = 56 # int | 

    try:
        # List Cluster Org Gpu Quotas
        api_response = api_instance.list_cluster_org_gpu_quotas_clusters_cluster_id_gpu_quota_organizations_get(cluster_id)
        print("The response of EXTERNALApi->list_cluster_org_gpu_quotas_clusters_cluster_id_gpu_quota_organizations_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->list_cluster_org_gpu_quotas_clusters_cluster_id_gpu_quota_organizations_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cluster_id** | **int**|  | 

### Return type

[**ListOrganizationGpuQuotaResponse**](ListOrganizationGpuQuotaResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_insights_insights_get**
> ListInsightsResponse list_insights_insights_get(status=status, severity=severity, cluster_id=cluster_id, deployment_id=deployment_id, resource_type=resource_type, observed_after=observed_after, limit=limit, before_id=before_id)

List Insights

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.insight_resource_type import InsightResourceType
from platform_api_python_client.models.insight_severity import InsightSeverity
from platform_api_python_client.models.insight_status import InsightStatus
from platform_api_python_client.models.list_insights_response import ListInsightsResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    status = ["new"] # List[InsightStatus] | Repeat to list several statuses (optional) (default to ["new"])
    severity = platform_api_python_client.InsightSeverity() # InsightSeverity |  (optional)
    cluster_id = 56 # int |  (optional)
    deployment_id = 56 # int |  (optional)
    resource_type = platform_api_python_client.InsightResourceType() # InsightResourceType |  (optional)
    observed_after = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    limit = 50 # int |  (optional) (default to 50)
    before_id = 56 # int |  (optional)

    try:
        # List Insights
        api_response = api_instance.list_insights_insights_get(status=status, severity=severity, cluster_id=cluster_id, deployment_id=deployment_id, resource_type=resource_type, observed_after=observed_after, limit=limit, before_id=before_id)
        print("The response of EXTERNALApi->list_insights_insights_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->list_insights_insights_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **status** | [**List[InsightStatus]**](InsightStatus.md)| Repeat to list several statuses | [optional] [default to ["new"]]
 **severity** | [**InsightSeverity**](.md)|  | [optional] 
 **cluster_id** | **int**|  | [optional] 
 **deployment_id** | **int**|  | [optional] 
 **resource_type** | [**InsightResourceType**](.md)|  | [optional] 
 **observed_after** | **datetime**|  | [optional] 
 **limit** | **int**|  | [optional] [default to 50]
 **before_id** | **int**|  | [optional] 

### Return type

[**ListInsightsResponse**](ListInsightsResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_service_accounts_service_accounts_get**
> ListServiceAccountsResponse list_service_accounts_service_accounts_get()

List Service Accounts

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.list_service_accounts_response import ListServiceAccountsResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)

    try:
        # List Service Accounts
        api_response = api_instance.list_service_accounts_service_accounts_get()
        print("The response of EXTERNALApi->list_service_accounts_service_accounts_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->list_service_accounts_service_accounts_get: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

[**ListServiceAccountsResponse**](ListServiceAccountsResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_unified_deployment_revisions_deployments_deployment_id_revisions_get**
> UnifiedListDeploymentRevisionsResponse list_unified_deployment_revisions_deployments_deployment_id_revisions_get(deployment_id)

List Unified Deployment Revisions

List a deployment's revisions, newest first, each read as GET /deployments/{deployment_id} reads the selected one. env.vars values are masked unless the caller owns the deployment or may manage the organization's deployments.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.unified_list_deployment_revisions_response import UnifiedListDeploymentRevisionsResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 

    try:
        # List Unified Deployment Revisions
        api_response = api_instance.list_unified_deployment_revisions_deployments_deployment_id_revisions_get(deployment_id)
        print("The response of EXTERNALApi->list_unified_deployment_revisions_deployments_deployment_id_revisions_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->list_unified_deployment_revisions_deployments_deployment_id_revisions_get: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 

### Return type

[**UnifiedListDeploymentRevisionsResponse**](UnifiedListDeploymentRevisionsResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **put_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_put**
> OrganizationGpuQuotaResponse put_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_put(cluster_id, organization_id, organization_gpu_quota_request)

Put Org Gpu Quota On Cluster

Persist organization GPU quota on this cluster and apply KAI Queue CRs.  ``gpu_quota`` of -1 is unlimited; a positive value is a hard cap. Rows are never removed. Requires ``CATALOG_TARGET_REVISION`` to contain ``catalog/src/catalog/kai_gpu_queues``.  A 200 means the quota row was saved and an Argo CD sync was requested (not that Queue CRs are already healthy). A 502 means the row was saved but the Application upsert/sync request failed; re-issue this idempotent PUT to retry.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.organization_gpu_quota_request import OrganizationGpuQuotaRequest
from platform_api_python_client.models.organization_gpu_quota_response import OrganizationGpuQuotaResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    cluster_id = 56 # int | 
    organization_id = 56 # int | 
    organization_gpu_quota_request = platform_api_python_client.OrganizationGpuQuotaRequest() # OrganizationGpuQuotaRequest | 

    try:
        # Put Org Gpu Quota On Cluster
        api_response = api_instance.put_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_put(cluster_id, organization_id, organization_gpu_quota_request)
        print("The response of EXTERNALApi->put_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->put_org_gpu_quota_on_cluster_clusters_cluster_id_organizations_organization_id_gpu_quota_put: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cluster_id** | **int**|  | 
 **organization_id** | **int**|  | 
 **organization_gpu_quota_request** | [**OrganizationGpuQuotaRequest**](OrganizationGpuQuotaRequest.md)|  | 

### Return type

[**OrganizationGpuQuotaResponse**](OrganizationGpuQuotaResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rollout_existing_revision_deployments_revisions_deployment_id_revision_number_put**
> UpdateDeploymentResponse rollout_existing_revision_deployments_revisions_deployment_id_revision_number_put(deployment_id, revision_number, rollout_strategy_params=rollout_strategy_params)

Rollout Existing Revision

Change the selected revision for a deployment and apply the changes.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.rollout_strategy_params import RolloutStrategyParams
from platform_api_python_client.models.update_deployment_response import UpdateDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    revision_number = 56 # int | 
    rollout_strategy_params = platform_api_python_client.RolloutStrategyParams() # RolloutStrategyParams |  (optional)

    try:
        # Rollout Existing Revision
        api_response = api_instance.rollout_existing_revision_deployments_revisions_deployment_id_revision_number_put(deployment_id, revision_number, rollout_strategy_params=rollout_strategy_params)
        print("The response of EXTERNALApi->rollout_existing_revision_deployments_revisions_deployment_id_revision_number_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->rollout_existing_revision_deployments_revisions_deployment_id_revision_number_put: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **revision_number** | **int**|  | 
 **rollout_strategy_params** | [**RolloutStrategyParams**](RolloutStrategyParams.md)|  | [optional] 

### Return type

[**UpdateDeploymentResponse**](UpdateDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **rollout_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_put**
> UnifiedWriteDeploymentResponse rollout_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_put(deployment_id, revision_number, max_surge=max_surge, max_unavailable=max_unavailable)

Rollout Unified Deployment Revision

Select a revision and roll the deployment out at it; ccl_job deployments cannot roll out a revision.  An ACTIVE deployment applies the revision. A PAUSED deployment only selects it, and a resume applies it. max_surge and max_unavailable shape this rollout only, for ccl_inference and ccl_dynamo.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.unified_write_deployment_response import UnifiedWriteDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    revision_number = 56 # int | 
    max_surge = 56 # int |  (optional)
    max_unavailable = 56 # int |  (optional)

    try:
        # Rollout Unified Deployment Revision
        api_response = api_instance.rollout_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_put(deployment_id, revision_number, max_surge=max_surge, max_unavailable=max_unavailable)
        print("The response of EXTERNALApi->rollout_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->rollout_unified_deployment_revision_deployments_deployment_id_revisions_revision_number_put: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **revision_number** | **int**|  | 
 **max_surge** | **int**|  | [optional] 
 **max_unavailable** | **int**|  | [optional] 

### Return type

[**UnifiedWriteDeploymentResponse**](UnifiedWriteDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **setup_stripe_customer_payments_setup_post**
> object setup_stripe_customer_payments_setup_post()

Setup Stripe Customer

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)

    try:
        # Setup Stripe Customer
        api_response = api_instance.setup_stripe_customer_payments_setup_post()
        print("The response of EXTERNALApi->setup_stripe_customer_payments_setup_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->setup_stripe_customer_payments_setup_post: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

**object**

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_cluster_clusters_cluster_id_put**
> object update_cluster_clusters_cluster_id_put(cluster_id, cluster_config)

Update Cluster

Validate a cluster component configuration for an org-owned cluster.  Infra provisioning is not wired yet; ``config.components`` is validated only.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.cluster_config import ClusterConfig
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    cluster_id = 56 # int | 
    cluster_config = platform_api_python_client.ClusterConfig() # ClusterConfig | 

    try:
        # Update Cluster
        api_response = api_instance.update_cluster_clusters_cluster_id_put(cluster_id, cluster_config)
        print("The response of EXTERNALApi->update_cluster_clusters_cluster_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_cluster_clusters_cluster_id_put: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cluster_id** | **int**|  | 
 **cluster_config** | [**ClusterConfig**](ClusterConfig.md)|  | 

### Return type

**object**

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_cluster_metadata_clusters_cluster_id_metadata_put**
> GetClusterResponse update_cluster_metadata_clusters_cluster_id_metadata_put(cluster_id, update_cluster_metadata_request)

Update Cluster Metadata

Update DB metadata for an org-owned cluster.  Global clusters (parent_id IS NULL) are not mutable here.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.get_cluster_response import GetClusterResponse
from platform_api_python_client.models.update_cluster_metadata_request import UpdateClusterMetadataRequest
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    cluster_id = 56 # int | 
    update_cluster_metadata_request = platform_api_python_client.UpdateClusterMetadataRequest() # UpdateClusterMetadataRequest | 

    try:
        # Update Cluster Metadata
        api_response = api_instance.update_cluster_metadata_clusters_cluster_id_metadata_put(cluster_id, update_cluster_metadata_request)
        print("The response of EXTERNALApi->update_cluster_metadata_clusters_cluster_id_metadata_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_cluster_metadata_clusters_cluster_id_metadata_put: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cluster_id** | **int**|  | 
 **update_cluster_metadata_request** | [**UpdateClusterMetadataRequest**](UpdateClusterMetadataRequest.md)|  | 

### Return type

[**GetClusterResponse**](GetClusterResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_compute_deployment_deployments_compute_put**
> UpdateDeploymentResponse update_compute_deployment_deployments_compute_put(deployment_id, create_compute_deployment_request)

Update Compute Deployment

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.create_compute_deployment_request import CreateComputeDeploymentRequest
from platform_api_python_client.models.update_deployment_response import UpdateDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    create_compute_deployment_request = platform_api_python_client.CreateComputeDeploymentRequest() # CreateComputeDeploymentRequest | 

    try:
        # Update Compute Deployment
        api_response = api_instance.update_compute_deployment_deployments_compute_put(deployment_id, create_compute_deployment_request)
        print("The response of EXTERNALApi->update_compute_deployment_deployments_compute_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_compute_deployment_deployments_compute_put: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **create_compute_deployment_request** | [**CreateComputeDeploymentRequest**](CreateComputeDeploymentRequest.md)|  | 

### Return type

[**UpdateDeploymentResponse**](UpdateDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_cserve_deployment_deployments_cserve_put**
> update_cserve_deployment_deployments_cserve_put()

Retired Cserve Deployment

### Example


```python
import platform_api_python_client
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)

    try:
        # Retired Cserve Deployment
        api_instance.update_cserve_deployment_deployments_cserve_put()
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_cserve_deployment_deployments_cserve_put: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**410** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_cserve_v2_deployment_deployments_cserve_v2_put**
> update_cserve_v2_deployment_deployments_cserve_v2_put()

Retired Cserve Deployment

### Example


```python
import platform_api_python_client
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)

    try:
        # Retired Cserve Deployment
        api_instance.update_cserve_v2_deployment_deployments_cserve_v2_put()
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_cserve_v2_deployment_deployments_cserve_v2_put: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**410** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_cserve_v3_deployment_deployments_cserve_v3_put**
> update_cserve_v3_deployment_deployments_cserve_v3_put()

Retired Cserve Deployment

### Example


```python
import platform_api_python_client
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)

    try:
        # Retired Cserve Deployment
        api_instance.update_cserve_v3_deployment_deployments_cserve_v3_put()
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_cserve_v3_deployment_deployments_cserve_v3_put: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**410** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_deployment_status_deployments_status_deployment_id_put**
> DeploymentStatusResponse update_deployment_status_deployments_status_deployment_id_put(deployment_id, deployment_status_request)

Update Deployment Status

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.deployment_status_request import DeploymentStatusRequest
from platform_api_python_client.models.deployment_status_response import DeploymentStatusResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    deployment_status_request = platform_api_python_client.DeploymentStatusRequest() # DeploymentStatusRequest | 

    try:
        # Update Deployment Status
        api_response = api_instance.update_deployment_status_deployments_status_deployment_id_put(deployment_id, deployment_status_request)
        print("The response of EXTERNALApi->update_deployment_status_deployments_status_deployment_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_deployment_status_deployments_status_deployment_id_put: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **deployment_status_request** | [**DeploymentStatusRequest**](DeploymentStatusRequest.md)|  | 

### Return type

[**DeploymentStatusResponse**](DeploymentStatusResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_deployment_status_v3_deployments_status_v3_deployment_id_put**
> DeploymentStatusV3Response update_deployment_status_v3_deployments_status_v3_deployment_id_put(deployment_id, update_deployment_status_v3_request)

Update Deployment Status V3

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.deployment_status_v3_response import DeploymentStatusV3Response
from platform_api_python_client.models.update_deployment_status_v3_request import UpdateDeploymentStatusV3Request
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    update_deployment_status_v3_request = platform_api_python_client.UpdateDeploymentStatusV3Request() # UpdateDeploymentStatusV3Request | 

    try:
        # Update Deployment Status V3
        api_response = api_instance.update_deployment_status_v3_deployments_status_v3_deployment_id_put(deployment_id, update_deployment_status_v3_request)
        print("The response of EXTERNALApi->update_deployment_status_v3_deployments_status_v3_deployment_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_deployment_status_v3_deployments_status_v3_deployment_id_put: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **update_deployment_status_v3_request** | [**UpdateDeploymentStatusV3Request**](UpdateDeploymentStatusV3Request.md)|  | 

### Return type

[**DeploymentStatusV3Response**](DeploymentStatusV3Response.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_dynamo_deployment_deployments_dynamo_put**
> UpdateDeploymentResponse update_dynamo_deployment_deployments_dynamo_put(deployment_id, create_dynamo_deployment_request)

Update Dynamo Deployment

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.create_dynamo_deployment_request import CreateDynamoDeploymentRequest
from platform_api_python_client.models.update_deployment_response import UpdateDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    create_dynamo_deployment_request = platform_api_python_client.CreateDynamoDeploymentRequest() # CreateDynamoDeploymentRequest | 

    try:
        # Update Dynamo Deployment
        api_response = api_instance.update_dynamo_deployment_deployments_dynamo_put(deployment_id, create_dynamo_deployment_request)
        print("The response of EXTERNALApi->update_dynamo_deployment_deployments_dynamo_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_dynamo_deployment_deployments_dynamo_put: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **create_dynamo_deployment_request** | [**CreateDynamoDeploymentRequest**](CreateDynamoDeploymentRequest.md)|  | 

### Return type

[**UpdateDeploymentResponse**](UpdateDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_inference_deployment_deployments_inference_put**
> UpdateDeploymentResponse update_inference_deployment_deployments_inference_put()

Update Inference Deployment

### Example


```python
import platform_api_python_client
from platform_api_python_client.models.update_deployment_response import UpdateDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)

    try:
        # Update Inference Deployment
        api_response = api_instance.update_inference_deployment_deployments_inference_put()
        print("The response of EXTERNALApi->update_inference_deployment_deployments_inference_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_inference_deployment_deployments_inference_put: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

[**UpdateDeploymentResponse**](UpdateDeploymentResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_inference_v3_deployment_deployments_inference_v3_put**
> UpdateDeploymentResponse update_inference_v3_deployment_deployments_inference_v3_put(deployment_id, create_inference_v3_deployment_request)

Update Inference V3 Deployment

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.create_inference_v3_deployment_request import CreateInferenceV3DeploymentRequest
from platform_api_python_client.models.update_deployment_response import UpdateDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    create_inference_v3_deployment_request = platform_api_python_client.CreateInferenceV3DeploymentRequest() # CreateInferenceV3DeploymentRequest | 

    try:
        # Update Inference V3 Deployment
        api_response = api_instance.update_inference_v3_deployment_deployments_inference_v3_put(deployment_id, create_inference_v3_deployment_request)
        print("The response of EXTERNALApi->update_inference_v3_deployment_deployments_inference_v3_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_inference_v3_deployment_deployments_inference_v3_put: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **create_inference_v3_deployment_request** | [**CreateInferenceV3DeploymentRequest**](CreateInferenceV3DeploymentRequest.md)|  | 

### Return type

[**UpdateDeploymentResponse**](UpdateDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_insight_status_insights_insight_id_status_patch**
> InsightResponse update_insight_status_insights_insight_id_status_patch(insight_id, update_insight_status_request)

Update Insight Status

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.insight_response import InsightResponse
from platform_api_python_client.models.update_insight_status_request import UpdateInsightStatusRequest
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    insight_id = 56 # int | 
    update_insight_status_request = platform_api_python_client.UpdateInsightStatusRequest() # UpdateInsightStatusRequest | 

    try:
        # Update Insight Status
        api_response = api_instance.update_insight_status_insights_insight_id_status_patch(insight_id, update_insight_status_request)
        print("The response of EXTERNALApi->update_insight_status_insights_insight_id_status_patch:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_insight_status_insights_insight_id_status_patch: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **insight_id** | **int**|  | 
 **update_insight_status_request** | [**UpdateInsightStatusRequest**](UpdateInsightStatusRequest.md)|  | 

### Return type

[**InsightResponse**](InsightResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_service_account_service_accounts_workos_id_put**
> ServiceAccountResponse update_service_account_service_accounts_workos_id_put(workos_id, update_service_account_request)

Update Service Account

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.service_account_response import ServiceAccountResponse
from platform_api_python_client.models.update_service_account_request import UpdateServiceAccountRequest
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    workos_id = 'workos_id_example' # str | 
    update_service_account_request = platform_api_python_client.UpdateServiceAccountRequest() # UpdateServiceAccountRequest | 

    try:
        # Update Service Account
        api_response = api_instance.update_service_account_service_accounts_workos_id_put(workos_id, update_service_account_request)
        print("The response of EXTERNALApi->update_service_account_service_accounts_workos_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_service_account_service_accounts_workos_id_put: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **workos_id** | **str**|  | 
 **update_service_account_request** | [**UpdateServiceAccountRequest**](UpdateServiceAccountRequest.md)|  | 

### Return type

[**ServiceAccountResponse**](ServiceAccountResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_unified_deployment_deployments_deployment_id_put**
> UnifiedWriteDeploymentResponse update_unified_deployment_deployments_deployment_id_put(deployment_id, unified_write_deployment_request, max_surge=max_surge, max_unavailable=max_unavailable)

Update Unified Deployment

Replace a deployment's request and roll it out; ccl_job deployments cannot be updated.  A PAUSED deployment stores the request without a rollout; a resume applies it. type, name, cluster_id and the pools keys cannot change. max_surge and max_unavailable shape this rollout only, for ccl_inference and ccl_dynamo.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.unified_write_deployment_request import UnifiedWriteDeploymentRequest
from platform_api_python_client.models.unified_write_deployment_response import UnifiedWriteDeploymentResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    unified_write_deployment_request = platform_api_python_client.UnifiedWriteDeploymentRequest() # UnifiedWriteDeploymentRequest | 
    max_surge = 56 # int |  (optional)
    max_unavailable = 56 # int |  (optional)

    try:
        # Update Unified Deployment
        api_response = api_instance.update_unified_deployment_deployments_deployment_id_put(deployment_id, unified_write_deployment_request, max_surge=max_surge, max_unavailable=max_unavailable)
        print("The response of EXTERNALApi->update_unified_deployment_deployments_deployment_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_unified_deployment_deployments_deployment_id_put: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **unified_write_deployment_request** | [**UnifiedWriteDeploymentRequest**](UnifiedWriteDeploymentRequest.md)|  | 
 **max_surge** | **int**|  | [optional] 
 **max_unavailable** | **int**|  | [optional] 

### Return type

[**UnifiedWriteDeploymentResponse**](UnifiedWriteDeploymentResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_unified_deployment_rollout_deployments_deployment_id_rollout_put**
> UnifiedGetDeploymentRolloutResponse update_unified_deployment_rollout_deployments_deployment_id_rollout_put(deployment_id, unified_update_deployment_rollout_request)

Update Unified Deployment Rollout

Pause or resume the in-flight rollout; not stored. Not implemented yet.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.unified_get_deployment_rollout_response import UnifiedGetDeploymentRolloutResponse
from platform_api_python_client.models.unified_update_deployment_rollout_request import UnifiedUpdateDeploymentRolloutRequest
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    unified_update_deployment_rollout_request = platform_api_python_client.UnifiedUpdateDeploymentRolloutRequest() # UnifiedUpdateDeploymentRolloutRequest | 

    try:
        # Update Unified Deployment Rollout
        api_response = api_instance.update_unified_deployment_rollout_deployments_deployment_id_rollout_put(deployment_id, unified_update_deployment_rollout_request)
        print("The response of EXTERNALApi->update_unified_deployment_rollout_deployments_deployment_id_rollout_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_unified_deployment_rollout_deployments_deployment_id_rollout_put: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **unified_update_deployment_rollout_request** | [**UnifiedUpdateDeploymentRolloutRequest**](UnifiedUpdateDeploymentRolloutRequest.md)|  | 

### Return type

[**UnifiedGetDeploymentRolloutResponse**](UnifiedGetDeploymentRolloutResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_unified_deployment_status_deployments_deployment_id_status_put**
> DeploymentStatusResponse update_unified_deployment_status_deployments_deployment_id_status_put(deployment_id, deployment_status_request)

Update Unified Deployment Status

Pause or resume a deployment, as PUT /deployments/status/{deployment_id} does.  Pauses and resumes ccl_compute, ccl_inference, ccl_job and ccl_dynamo deployments through ccluster. DELETE /deployments/{deployment_id} deletes them.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.deployment_status_request import DeploymentStatusRequest
from platform_api_python_client.models.deployment_status_response import DeploymentStatusResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    deployment_id = 56 # int | 
    deployment_status_request = platform_api_python_client.DeploymentStatusRequest() # DeploymentStatusRequest | 

    try:
        # Update Unified Deployment Status
        api_response = api_instance.update_unified_deployment_status_deployments_deployment_id_status_put(deployment_id, deployment_status_request)
        print("The response of EXTERNALApi->update_unified_deployment_status_deployments_deployment_id_status_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_unified_deployment_status_deployments_deployment_id_status_put: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deployment_id** | **int**|  | 
 **deployment_status_request** | [**DeploymentStatusRequest**](DeploymentStatusRequest.md)|  | 

### Return type

[**DeploymentStatusResponse**](DeploymentStatusResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **update_user_vault_item_endpoint_user_vault_put**
> UserVaultItem update_user_vault_item_endpoint_user_vault_put(upsert_user_vault_item_request)

Update User Vault Item Endpoint

Create an immutable vault item. Existing secrets cannot be updated.  Reusing an active type, key, and visibility returns 409, even for the same value. To replace a secret, create one with a new key and update its consumers before deleting the old secret. Recreating a deleted key allocates a new secret ID. The PUT route and request name are retained for existing clients.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.upsert_user_vault_item_request import UpsertUserVaultItemRequest
from platform_api_python_client.models.user_vault_item import UserVaultItem
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = platform_api_python_client.EXTERNALApi(api_client)
    upsert_user_vault_item_request = platform_api_python_client.UpsertUserVaultItemRequest() # UpsertUserVaultItemRequest | 

    try:
        # Update User Vault Item Endpoint
        api_response = api_instance.update_user_vault_item_endpoint_user_vault_put(upsert_user_vault_item_request)
        print("The response of EXTERNALApi->update_user_vault_item_endpoint_user_vault_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EXTERNALApi->update_user_vault_item_endpoint_user_vault_put: %s\n" % e)
```



### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **upsert_user_vault_item_request** | [**UpsertUserVaultItemRequest**](UpsertUserVaultItemRequest.md)|  | 

### Return type

[**UserVaultItem**](UserVaultItem.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response |  -  |
**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)