platform-api-python-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• Package version: 4.26.1
• Generator version: 7.9.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/centml/platform/client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/centml/platform/client.git)

Then import the package:

importplatform_api_python_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importplatform_api_python_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

importplatform_api_python_clientfromplatform_api_python_client.restimportApiExceptionfrompprintimportpprint# 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: HTTPBearerconfiguration=platform_api_python_client.Configuration(
access_token=os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API clientwithplatform_api_python_client.ApiClient(configuration) asapi_client:
# Create an instance of the API classapi_instance=platform_api_python_client.EXTERNALApi(api_client)
cluster_registration_request=platform_api_python_client.ClusterRegistrationRequest() # ClusterRegistrationRequest | try:
# Create Clusterapi_response=api_instance.create_cluster_clusters_post(cluster_registration_request)
print("The response of EXTERNALApi->create_cluster_clusters_post:\n")
pprint(api_response)
exceptApiExceptionase:
print("Exception when calling EXTERNALApi->create_cluster_clusters_post: %s\n"%e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
EXTERNALApi	create_cluster_clusters_post	POST /clusters	Create Cluster
EXTERNALApi	create_compute_deployment_deployments_compute_post	POST /deployments/compute	Create Compute Deployment
EXTERNALApi	create_cserve_v2_deployment_deployments_cserve_v2_post	POST /deployments/cserve_v2	Create Cserve V2 Deployment
EXTERNALApi	create_cserve_v3_deployment_deployments_cserve_v3_post	POST /deployments/cserve_v3	Create Cserve V3 Deployment
EXTERNALApi	create_dynamo_deployment_deployments_dynamo_post	POST /deployments/dynamo	Create Dynamo Deployment
EXTERNALApi	create_hardware_instance_hardware_instances_post	POST /hardware-instances	Create Hardware Instance
EXTERNALApi	create_inference_deployment_deployments_inference_post	POST /deployments/inference	Create Inference Deployment
EXTERNALApi	create_inference_v3_deployment_deployments_inference_v3_post	POST /deployments/inference_v3	Create Inference V3 Deployment
EXTERNALApi	create_job_deployment_deployments_job_post	POST /deployments/job	Create Job Deployment
EXTERNALApi	create_new_organization_organizations_post	POST /organizations	Create New Organization
EXTERNALApi	create_service_account_service_accounts_post	POST /service-accounts	Create Service Account
EXTERNALApi	create_volume_endpoint_volumes_post	POST /volumes	Create Volume Endpoint
EXTERNALApi	delete_cluster_clusters_cluster_id_delete	DELETE /clusters/{cluster_id}	Delete Cluster
EXTERNALApi	delete_hardware_instance_hardware_instances_hardware_instance_id_delete	DELETE /hardware-instances/{hardware_instance_id}	Delete Hardware Instance
EXTERNALApi	delete_service_account_service_accounts_workos_id_delete	DELETE /service-accounts/{workos_id}	Delete Service Account
EXTERNALApi	delete_user_vault_item_by_id_endpoint_user_vault_secret_id_delete	DELETE /user_vault/{secret_id}	Delete User Vault Item By Id Endpoint
EXTERNALApi	delete_user_vault_item_endpoint_user_vault_delete	DELETE /user_vault	Delete User Vault Item Endpoint
EXTERNALApi	delete_volume_endpoint_volumes_volume_id_delete	DELETE /volumes/{volume_id}	Delete Volume Endpoint
EXTERNALApi	generate_service_account_secret_service_accounts_workos_id_secrets_post	POST /service-accounts/{workos_id}/secrets	Generate Service Account Secret
EXTERNALApi	get_all_user_vault_items_endpoint_user_vault_get	GET /user_vault	Get All User Vault Items Endpoint
EXTERNALApi	get_all_volumes_endpoint_volumes_get	GET /volumes	Get All Volumes Endpoint
EXTERNALApi	get_clusters_clusters_get	GET /clusters	Get Clusters
EXTERNALApi	get_compute_deployment_deployments_compute_deployment_id_get	GET /deployments/compute/{deployment_id}	Get Compute Deployment
EXTERNALApi	get_credits_credits_get	GET /credits	Get Credits
EXTERNALApi	get_cserve_recipe_deployments_cserve_recipes_get	GET /deployments/cserve/recipes	Get Cserve Recipe
EXTERNALApi	get_cserve_v2_deployment_deployments_cserve_v2_deployment_id_get	GET /deployments/cserve_v2/{deployment_id}	Get Cserve V2 Deployment
EXTERNALApi	get_cserve_v3_deployment_deployments_cserve_v3_deployment_id_get	GET /deployments/cserve_v3/{deployment_id}	Get Cserve V3 Deployment
EXTERNALApi	get_deployment_logs_deployments_logs_deployment_id_get	GET /deployments/logs/{deployment_id}	Get Deployment Logs
EXTERNALApi	get_deployment_logs_v3_deployments_logs_v3_deployment_id_revision_number_get	GET /deployments/logs_v3/{deployment_id}/{revision_number}	Get Deployment Logs V3
EXTERNALApi	get_deployment_logs_v4_logs_deployment_id_revision_number_get	GET /logs/{deployment_id}/{revision_number}	Get Deployment Logs V4
EXTERNALApi	get_deployment_pods_deployments_pods_deployment_id_revision_number_get	GET /deployments/pods/{deployment_id}/{revision_number}	Get Deployment Pods
EXTERNALApi	get_deployment_revision_deployments_revisions_deployment_id_revision_number_get	GET /deployments/revisions/{deployment_id}/{revision_number}	Get Deployment Revision
EXTERNALApi	get_deployment_revisions_deployments_revisions_deployment_id_get	GET /deployments/revisions/{deployment_id}	Get Deployment Revisions
EXTERNALApi	get_deployment_status_deployments_status_deployment_id_get	GET /deployments/status/{deployment_id}	Get Deployment Status
EXTERNALApi	get_deployment_status_v3_deployments_status_v3_deployment_id_get	GET /deployments/status_v3/{deployment_id}	Get Deployment Status V3
EXTERNALApi	get_deployments_deployments_get	GET /deployments	Get Deployments
EXTERNALApi	get_dynamo_deployment_deployments_dynamo_deployment_id_get	GET /deployments/dynamo/{deployment_id}	Get Dynamo Deployment
EXTERNALApi	get_hardware_instances_hardware_instances_get	GET /hardware-instances	Get Hardware Instances
EXTERNALApi	get_hardware_presets_hardware_presets_get	GET /hardware-presets	Get Hardware Presets
EXTERNALApi	get_inference_deployment_deployments_inference_deployment_id_get	GET /deployments/inference/{deployment_id}	Get Inference Deployment
EXTERNALApi	get_inference_v3_deployment_deployments_inference_v3_deployment_id_get	GET /deployments/inference_v3/{deployment_id}	Get Inference V3 Deployment
EXTERNALApi	get_job_deployment_deployments_job_deployment_id_get	GET /deployments/job/{deployment_id}	Get Job Deployment
EXTERNALApi	get_prebuilt_images_prebuilt_images_get	GET /prebuilt-images	Get Prebuilt Images
EXTERNALApi	get_usage_daily_bills_get	GET /daily_bills	Get Usage
EXTERNALApi	get_usage_deployments_usage_deployment_id_get	GET /deployments/usage/{deployment_id}	Get Usage
EXTERNALApi	get_user_vault_item_by_id_endpoint_user_vault_secret_id_get	GET /user_vault/{secret_id}	Get User Vault Item By Id Endpoint
EXTERNALApi	get_volume_endpoint_volumes_volume_id_get	GET /volumes/{volume_id}	Get Volume Endpoint
EXTERNALApi	get_volume_status_endpoint_volumes_status_volume_id_get	GET /volumes/status/{volume_id}	Get Volume Status Endpoint
EXTERNALApi	invite_user_organizations_invite_post	POST /organizations/invite	Invite User
EXTERNALApi	list_cluster_capacity_capacity_get	GET /capacity	List Cluster Capacity
EXTERNALApi	list_service_accounts_service_accounts_get	GET /service-accounts	List Service Accounts
EXTERNALApi	rollout_existing_revision_deployments_revisions_deployment_id_revision_number_put	PUT /deployments/revisions/{deployment_id}/{revision_number}	Rollout Existing Revision
EXTERNALApi	setup_stripe_customer_payments_setup_post	POST /payments/setup	Setup Stripe Customer
EXTERNALApi	update_cluster_clusters_cluster_id_put	PUT /clusters/{cluster_id}	Update Cluster
EXTERNALApi	update_cluster_metadata_clusters_cluster_id_metadata_put	PUT /clusters/{cluster_id}/metadata	Update Cluster Metadata
EXTERNALApi	update_compute_deployment_deployments_compute_put	PUT /deployments/compute	Update Compute Deployment
EXTERNALApi	update_cserve_v2_deployment_deployments_cserve_v2_put	PUT /deployments/cserve_v2	Update Cserve V2 Deployment
EXTERNALApi	update_cserve_v3_deployment_deployments_cserve_v3_put	PUT /deployments/cserve_v3	Update Cserve V3 Deployment
EXTERNALApi	update_deployment_status_deployments_status_deployment_id_put	PUT /deployments/status/{deployment_id}	Update Deployment Status
EXTERNALApi	update_deployment_status_v3_deployments_status_v3_deployment_id_put	PUT /deployments/status_v3/{deployment_id}	Update Deployment Status V3
EXTERNALApi	update_dynamo_deployment_deployments_dynamo_put	PUT /deployments/dynamo	Update Dynamo Deployment
EXTERNALApi	update_inference_deployment_deployments_inference_put	PUT /deployments/inference	Update Inference Deployment
EXTERNALApi	update_inference_v3_deployment_deployments_inference_v3_put	PUT /deployments/inference_v3	Update Inference V3 Deployment
EXTERNALApi	update_service_account_service_accounts_workos_id_put	PUT /service-accounts/{workos_id}	Update Service Account
EXTERNALApi	update_user_vault_item_endpoint_user_vault_put	PUT /user_vault	Update User Vault Item Endpoint

Documentation For Models

• ArgoRollouts
• BackendProtocol
• CServeRecipePerf
• CServeRecipeResponse
• CServeV2Recipe
• CertManager
• CloudProvider
• ClusterCapacityResponse
• ClusterComponents
• ClusterConfig
• ClusterCredential
• ClusterRegistrationRequest
• ClusterRegistrationResponse
• ConfigFileMount
• CreateCServeV2DeploymentResponse
• CreateCServeV3DeploymentRequest
• CreateCServeV3DeploymentResponse
• CreateComputeDeploymentRequest
• CreateComputeDeploymentResponse
• CreateDynamoDeploymentRequest
• CreateDynamoDeploymentResponse
• CreateFilesystemVolumeRequest
• CreateHardwareInstanceRequest
• CreateInferenceDeploymentResponse
• CreateInferenceV3DeploymentRequest
• CreateJobDeploymentRequest
• CreateJobDeploymentResponse
• CreateObjectVolumeRequest
• CreateOrganizationRequest
• CreateOrganizationResponse
• CreateServiceAccountRequest
• CreateServiceAccountResponse
• CreateVolumeRequest
• CreditsResponse
• DailyBillResponse
• DeleteUserVaultItemRequest
• DeploymentComponentType
• DeploymentLogEventV4
• DeploymentResponse
• DeploymentStatus
• DeploymentStatusRequest
• DeploymentStatusResponse
• DeploymentStatusV3Response
• DeploymentType
• DeploymentUsage
• DeploymentUsageValue
• DynamoServingMode
• DynamoWorkerPoolConfig
• DynamoWorkerPools
• ExternalDns
• FinalStack
• FluentBit
• GenerateServiceAccountSecretResponse
• GetCServeV2DeploymentResponse
• GetCServeV3DeploymentResponse
• GetClusterResponse
• GetComputeDeploymentResponse
• GetDeploymentLogResponse
• GetDeploymentLogV4Response
• GetDeploymentPodsResponse
• GetDeploymentResponse
• GetDeploymentRevisionResponse
• GetDeploymentUsageResponse
• GetDynamoDeploymentResponse
• GetFilesystemVolumeResponse
• GetInferenceDeploymentResponse
• GetInferenceV3DeploymentResponse
• GetJobDeploymentResponse
• GetObjectVolumeResponse
• GetVolumeResponse
• GpuOperator
• GpuTypeCapacity
• HTTPValidationError
• HardwareInstanceResponse
• HardwarePresetResponse
• ImagePullSecretCredentials
• IngressNginx
• InviteUserRequest
• Istio
• IstioCniOverrides
• IstioCniSubchartOverrides
• IstioOverrides
• Keda
• KubePrometheusStack
• ListCServeRecipeResponse
• ListClusterCapacityResponse
• ListDailyBillResponse
• ListDeploymentRevisionsResponse
• ListGetClusterResponse
• ListGetDeploymentResponse
• ListHardwareInstanceResponse
• ListHardwarePresetResponse
• ListPrebuiltImageResponse
• ListServiceAccountsResponse
• ListUserVaultItemsResponse
• ListVolumesResponse
• Longhorn
• Metric
• MetricsConfig
• MetricsServer
• NetworkOperator
• ObjectStorageProvider
• OpentelemetryCollector
• PodDetails
• PodStatus
• PrebuiltImageResponse
• PrometheusAdapter
• RevisionPodDetails
• RolloutStatus
• RolloutStrategyParams
• ServiceAccountResponse
• ServiceStatus
• Spire
• SpireCrds
• TeleportKubeAgent
• UpdateClusterMetadataRequest
• UpdateDeploymentResponse
• UpdateDeploymentStatusV3Request
• UpdateServiceAccountRequest
• UpsertUserVaultItemRequest
• UserVaultItem
• UserVaultType
• ValidationError
• ValidationErrorLocInner
• VaultScope
• VolumeAccessMode
• VolumeBackend
• VolumeMount
• VolumeStatus
• VolumeStatusResponse

Documentation For Authorization

Authentication schemes defined for the API:

HTTPBearer

• Type: Bearer authentication

Author