Skip to main content

Methods

Retrieves a list of all latest Clusters. Pagination is available based on query parameters.

Parameters

typing.Optional[int]
Number of items per page
typing.Optional[int]
Number of items to skip

Returns

SyncPager[Cluster, ListClustersResponse]
🔗 ListClustersResponseRetrieve latest Clusters. If pagination parameters are provided, the response includes paginated data.

Usage

Create or Update cluster with provided manifest

Parameters

ClusterManifest
required
🔗 ClusterManifestCluster manifest
typing.Optional[bool]
Dry run the cluster creation/update

Returns

GetClusterResponse
🔗 GetClusterResponseReturns newly created/updated cluster on success

Usage

Get cluster associated with provided id

Parameters

str
required
Cluster id of the cluster

Returns

GetClusterResponse
🔗 GetClusterResponseReturn the cluster associated with provided id

Usage

Delete cluster associated with provided cluster id

Parameters

str
required
Cluster id of the cluster

Returns

ClustersDeleteResponse
🔗 ClustersDeleteResponseReturns success message on successful deletion

Usage

List addons for the provided cluster. Pagination is available based on query parameters.

Parameters

str
required
Cluster id of the cluster
typing.Optional[int]
Number of items per page
typing.Optional[int]
Number of items to skip

Returns

ListClusterAddonsResponse
🔗 ListClusterAddonsResponseReturns a paginated list of addons for the cluster

Usage

Get the status of provided cluster

Parameters

str
required
Cluster id of the cluster

Returns

IsClusterConnectedResponse
🔗 IsClusterConnectedResponseReturns the status of provided cluster

Usage