Skip to main content

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

Name to validate

workspaceId

integer

path

Required

Workspace numeric identifier

max

integer

query

Optional

Pagination result max result

offset

integer

query

Optional

Pagination offset

search

string

query

Optional

Filter search parameter

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.name

string

Required

workspace.fullName

string

Required

workspace.description

string

Optional

workspace.visibility

string

Required

workspace.dateCreated

string

Optional

workspace.lastUpdated

string

Optional

UpdateWorkspace

Update workspace

name

string

Optional

fullName

string

Optional

description

string

Optional

visibility

string

Optional

CreateWorkspaceParticipant

Create workspace participant

memberId

integer

Optional

teamId

integer

Optional

userNameOrEmail

string

Optional

UpdateWorkspaceParticipantRole

Update participant role

role

string

Optional

FindDataStudiosWorkspaceSettings

List 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