Skip to main content

Methods

List workspaces associated with the user. Optional filters include clusterId, fqn, and workspace name.

Parameters

typing.Optional[int]
Number of items per page
typing.Optional[int]
Number of items to skip
typing.Optional[str]
ClusterId of the Cluster
typing.Optional[str]
Workspace Name
typing.Optional[str]
Workspace FQN
typing.Optional[bool]
When true, each workspace includes cluster information

Returns

SyncPager[Workspace, ListWorkspacesResponse]
🔗 ListWorkspacesResponseReturns all the workspaces associated with a user and also the response includes paginated data.

Usage

Creates a new workspace or updates an existing one based on the provided manifest.

Parameters

WorkspaceManifest
required
🔗 WorkspaceManifestWorkspace manifest
typing.Optional[bool]
Dry run the request

Returns

GetWorkspaceResponse
🔗 GetWorkspaceResponse
  • Creates or updates a workspace with given manifest
  • Corresponding authorization entry with admin role is made using newly created workspace
  • Attached with the cluster id where the workspace is created

Usage

List workspaces the user can read with optional structured filter (name, id, environmentId, cluster_fqn) and pagination.

Parameters

typing.Optional[int]
Number of items per page
typing.Optional[int]
Number of items to skip
typing.Optional[str]
JSON string containing array of search filters with string, type and operator
typing.Optional[bool]
When true, each workspace includes cluster information

Returns

SyncPager[Workspace, ListWorkspacesResponse]
🔗 ListWorkspacesResponsePaginated workspaces matching the filter.

Usage

Get workspace associated with provided workspace id

Parameters

str
required
Workspace id of the space

Returns

GetWorkspaceResponse
🔗 GetWorkspaceResponseReturns the workspaces associated with provided workspace id

Usage

Deletes the workspace with the given workspace ID.

Parameters

str
required
Workspace id of the space

Returns

WorkspacesDeleteResponse
🔗 WorkspacesDeleteResponseSuccessfully deletes the workspace and returns the workspace details along with a confirmation message.

Usage

Get Workspace by FQN.

Parameters

str
required
FQN of the workspace

Returns

GetWorkspaceResponse
🔗 GetWorkspaceResponseWorkspace details

Usage