Skip to main content

Pipeline runs (workflows)

Manage workflow executions (pipeline runs) in Seqera Platform.

Path and query parameters

Name

Type

Location

Req/Opt

Description

attributes

array

query

Optional

Additional attribute values to include in the response (labels, optimized status). Returns an empty value (labels: null) if omitted. Specify minimal to remove non-essential fields (for use in UI only).

workspaceId

integer

query

Optional

Workspace numeric identifier

max

integer

query

Optional

Pagination result max result

offset

integer

query

Optional

Pagination offset

search

string

query

Optional

Filter search parameter

force

boolean

query

Optional

Force the deletion even if any workflows are active

sourceWorkspaceId

integer

query

Optional

Source workspace numeric identifier

runName

string

query

Optional

Workflow run name to validate

sessionId

string

query

Optional

Workflow session ID to validate

workflowId

string

path

Required

Workflow string identifier

fileName

string

query

Optional

Filename to download

taskId

integer

path

Required

Task numeric identifier

next

string

query

Optional

Workflow log cursor

sortBy

string

query

Optional

Field to sort by

sortDir

string

query

Optional

Sorting direction (asc|desc)

Request body parameters

Name

Type

Req/Opt

Description

DeleteWorkflowMany

Delete workflows

workflowIds

array

Optional

CreateWorkflowLaunch

Launch workflow

launch

object

Optional

launch.id

string

Optional

launch.computeEnvId

string

Optional

launch.runName

string

Optional

launch.pipeline

string

Optional

launch.workDir

string

Optional

launch.revision

string

Optional

launch.sessionId

string

Optional

launch.configProfiles

array

Optional

launch.userSecrets

array

Optional

launch.workspaceSecrets

array

Optional

launch.configText

string

Optional

launch.towerConfig

string

Optional

launch.paramsText

string

Optional

launch.preRunScript

string

Optional

launch.postRunScript

string

Optional

launch.mainScript

string

Optional

launch.entryName

string

Optional

launch.schemaName

string

Optional

launch.resume

boolean

Optional

launch.pullLatest

boolean

Optional

launch.stubRun

boolean

Optional

launch.optimizationId

string

Optional

launch.optimizationTargets

string

Optional

launch.labelIds

array

Optional

launch.headJobCpus

integer

Optional

launch.headJobMemoryMb

integer

Optional

launch.launchContainer

string

Optional

launch.dateCreated

string

Optional

CancelWorkflow

Cancel workflow