Workspaces

Workspaces are organizational units to manage Seqera resources such as pipelines, Studios, compute environments, and credentials, in a user or organization context.

Path and query parameters

Name	Type	Location	Req/Opt	Description
orgId	integer	path	Required	Organization numeric identifier.
name	string	query	Optional	The workspace name to validate for availability and format compliance within the organization.
workspaceId	integer	path	Required	Workspace numeric identifier.
max	integer	query	Optional	Maximum number of results to return. Default: 50.
offset	integer	query	Optional	Number of results to skip for pagination. Default: 0.
search	string	query	Optional	Free-text search filter to match against participant names and email addresses.
participantId	integer	path	Required	Participant numeric identifier.
userId	integer	path	Required	User numeric identifier.

Request body parameters

Name	Type	Req/Opt	Description
CreateWorkspace			Create workspace
workspace	object	Optional
workspace.id	integer	Optional	Workspace numeric identifier.
workspace.name	string	Required	Unique workspace name within the organization. Must be 2-40 characters, start and end with alphanumeric characters, and can contain hyphens or underscores between characters.
workspace.fullName	string	Required	Full display name for the workspace. Maximum 100 characters.
workspace.description	string	Optional	Optional description of the workspace. Maximum 1000 characters.
workspace.visibility	string	Required
workspace.dateCreated	string	Optional	Timestamp when the workspace was created.
workspace.lastUpdated	string	Optional	Timestamp when the workspace was last updated.
UpdateWorkspace			Update workspace
name	string	Optional
fullName	string	Optional
description	string	Optional
visibility	string	Optional
CreateWorkspaceParticipant			Create workspace participant
memberId	integer	Optional	Organization member numeric identifier to add as a workspace participant. Provide either memberId or teamId.
teamId	integer	Optional	Team numeric identifier to add as a workspace participant. Provide either memberId or teamId.
userNameOrEmail	string	Optional	Username or email address of the user to add as a workspace participant. Alternative to providing memberId.
UpdateWorkspaceParticipantRole			Update workspace participant role
role	string	Optional
FindDataStudiosWorkspaceSettings			Describe workspace Studios settings
name	string	Optional
fullName	string	Optional
description	string	Optional
visibility	string	Optional
UpdateDataStudiosWorkspaceSettings			Update workspace Studios settings
name	string	Optional
fullName	string	Optional
description	string	Optional
visibility	string	Optional