Skip to main content

Methods

Retrieves a list of all latest applications. Supports filtering by application ID, name, type, and other parameters. Pagination is available based on query parameters.

Parameters

typing.Optional[int]
Number of items per page
typing.Optional[int]
Number of items to skip
typing.Optional[str]
Application id of the application
typing.Optional[str]
Workspace id of the application (comma separated for multiple)
typing.Optional[str]
Name of application
typing.Optional[str]
Fully qualified name (FQN) of the application
typing.Optional[str]
Fully qualified name (FQN) of the workspace
typing.Optional[str]
Type of application (comma separated for multiple). Allowed Values: async-service, service, job, spark-job, helm, notebook, spark-notebook, codeserver, rstudio, ssh-server, volume, application, application-set, intercept, workflow
typing.Optional[str]
Search query for application name
typing.Optional[str]
Filter by Environment ids of the application (comma separated for multiple)
typing.Optional[str]
Filter by Cluster ids of the application (comma separated for multiple)
typing.Optional[str]
Filter by Application Set id of the application
typing.Optional[bool]
Filter by Application Paused status
typing.Optional[ApplicationsListRequestDeviceTypeFilter]
🔗 ApplicationsListRequestDeviceTypeFilterFilter by device type of the application. Allowed values: cpu, nvidia_gpu, aws_inferentia, nvidia_mig_gpu, nvidia_timeslicing_gpu, gcp_tpu
typing.Optional[str]
Filter by last deployed by specific users
typing.Optional[ApplicationsListRequestLifecycleStage]
🔗 ApplicationsListRequestLifecycleStageFilter by application lifecycle state
typing.Optional[bool]
Filter out applications with recommendations that are allowed to be shown

Returns

SyncPager[Application, ListApplicationsResponse]
🔗 ListApplicationsResponseRetrieve latest applications based on the specified query parameters. If pagination parameters are provided, the response includes paginated data.

Usage

Create a new Application Deployment based on the provided manifest.

Parameters

typing.Dict[str, typing.Any]
required
Manifest of application
typing.Optional[bool]
Dry run
typing.Optional[bool]
Cancels any ongoing deployments
typing.Optional[bool]
Trigger on deploy
typing.Optional[str]
workspace id of the workspace
typing.Optional[str]
Id of the application
typing.Optional[str]
Name of application
typing.Optional[str]
Application Set Id

Returns

GetApplicationDeploymentResponse
🔗 GetApplicationDeploymentResponseReturns new deployment on successful creation
  • It also creates an application if not already present
  • validates third party requirements
  • updates application, version

Usage

Get Application associated with the provided application ID.

Parameters

str
required
Id of the application

Returns

GetApplicationResponse
🔗 GetApplicationResponseApplication details retrieved successfully

Usage

Delete Application associated with the provided application ID.

Parameters

str
required
Id of the application

Returns

DeleteApplicationResponse
🔗 DeleteApplicationResponseDelete application response.

Usage

Creates a new deployment with the same manifest as the given deployment.

Parameters

str
required
Application id of the application
str
required
Deployment id of the deployment

Returns

GetApplicationDeploymentResponse
🔗 GetApplicationDeploymentResponseReturns the new deployment.

Usage

Pause a running application by scaling to 0 replicas

Parameters

str
required
Id of the application

Returns

None

Usage

Resume a paused application by scaling back to the original number of replicas

Parameters

str
required
Id of the application

Returns

Deployment
🔗 DeploymentScales back a paused applicaion to the original number of replicas

Usage

Cancel an ongoing deployment associated with the provided application ID and deployment ID.

Parameters

str
required
Application id of the application
str
required
Deployment id of the deployment

Returns

ApplicationsCancelDeploymentResponse
🔗 ApplicationsCancelDeploymentResponseDeployment cancelled successfully.

Usage

Get Application by FQN.

Parameters

str
required
FQN of the application

Returns

GetApplicationResponse
🔗 GetApplicationResponseApplication details

Usage