Methods
list
list
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
create_or_update
create_or_update
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
search
search
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
get
delete
delete