Skip to main content

Methods

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

Parameters

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

Returns

SyncPager[Workspace, ListWorkspacesResponse]
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

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

Returns

GetWorkspaceResponse
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

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

Returns

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

Usage

Get workspace associated with provided workspace id

Parameters

id
str
required
Workspace id of the space

Returns

GetWorkspaceResponse
GetWorkspaceResponse
🔗 GetWorkspaceResponseReturns the workspaces associated with provided workspace id

Usage

Deletes the workspace with the given workspace ID.

Parameters

id
str
required
Workspace id of the space

Returns

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

Usage

Get Workspace by FQN.

Parameters

fqn
str
required
FQN of the workspace

Returns

GetWorkspaceResponse
GetWorkspaceResponse
🔗 GetWorkspaceResponseWorkspace details

Usage