Pipeline runs (workflows)

Manage workflow executions (pipeline runs) in Seqera Platform.

The List workflows and Describe workflow endpoints support the attributes query parameter to enrich the default response. Current supported values are optimized, labels, messages, minimal, and pipelineInfo.

Use attributes=pipelineInfo to include the source pipeline reference for a run, including the pipeline identifier, workspace identifier, and version metadata.

Path and query parameters

Name	Type	Location	Req/Opt	Description
attributes	array	query	Optional	Additional attribute values to include in the response. Supported values are optimized, labels, messages, minimal, and pipelineInfo. Returns null for attributes omitted from the request.
workspaceId	integer	query	Optional	Workspace identifier
max	integer	query	Optional	Pagination max results
offset	integer	query	Optional	Pagination offset
search	string	query	Optional	Filter search parameter
includeTotalSize	boolean	query	Optional	If true, includes total result count in the response. Default: true.
force	boolean	query	Optional	Force the deletion even if any workflows are active
sourceWorkspaceId	integer	query	Optional	Source workspace identifier
runName	string	query	Optional	Workflow run name to validate
sessionId	string	query	Optional	Workflow session ID to validate
workflowId	string	path	Required	Workflow identifier
fileName	string	query	Optional	Filename to download
taskId	integer	path	Required	Task identifier
next	string	query	Optional	Workflow log cursor
maxLength	integer	query	Optional	Maximum length in bytes of the log to retrieve
sortBy	string	query	Optional	Field to sort by
sortDir	string	query	Optional	Sorting direction (asc|desc)
process	string	query	Optional	Exact process name to filter tasks by.

Request body parameters

Name	Type	Req/Opt	Description
DeleteWorkflowMany			Delete workflows
workflowIds	array	Optional	Array of workflow identifiers to delete.
CreateWorkflowLaunch			Launch workflow
launch	object	Optional	Workflow launch configuration.
launch.id	string	Optional	Launch configuration identifier.
launch.computeEnvId	string	Optional	Compute environment identifier where the pipeline will run. Defaults to workspace primary compute environment if omitted.
launch.runName	string	Optional	Custom run name for the workflow execution.
launch.pipeline	string	Optional	Pipeline repository URL (e.g., https://github.com/nextflow-io/hello).
launch.workDir	string	Optional	Work directory path where workflow intermediate files are stored. Defaults to compute environment work directory if omitted.
launch.revision	string	Optional	Git revision, branch, or tag to use.
launch.sessionId	string	Optional	Nextflow session identifier for resuming failed runs.
launch.configProfiles	array	Optional	Array of Nextflow configuration profile names to apply.
launch.userSecrets	array	Optional	Array of user secrets to make available to the pipeline.
launch.workspaceSecrets	array	Optional	Array of workspace secrets to make available to the pipeline.
launch.configText	string	Optional	Nextflow configuration as text (overrides config files).
launch.towerConfig	string	Optional	Platform-specific configuration options.
launch.paramsText	string	Optional	Pipeline parameters in JSON or YAML format.
launch.preRunScript	string	Optional	Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
launch.postRunScript	string	Optional	Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
launch.mainScript	string	Optional	Alternative main script filename. Default: main.nf.
launch.entryName	string	Optional	Workflow entry point name when using Nextflow DSL2.
launch.schemaName	string	Optional	Name of the pipeline schema to use.
launch.resume	boolean	Optional	Enable resume to restart workflow execution from the last successful process. See Resume a workflow run.
launch.pullLatest	boolean	Optional	Pull the latest version of the pipeline from the repository.
launch.stubRun	boolean	Optional	Execute a stub run for testing (processes return dummy results).
launch.optimizationId	string	Optional	Optimization configuration identifier. See Pipeline resource optimization.
launch.optimizationTargets	string	Optional	Comma-separated list of optimization targets. See Pipeline resource optimization.
launch.labelIds	array	Optional	Array of label IDs to assign to each pipeline run.
launch.headJobCpus	integer	Optional	Number of CPUs allocated for the Nextflow head job.
launch.headJobMemoryMb	integer	Optional	Memory allocation for the Nextflow head job in megabytes.
launch.launchContainer	string	Optional	Container image to use for the Nextflow launcher.
launch.dateCreated	string	Optional	Timestamp when the launch configuration was created.
launch.outputDir	string	Optional	Output directory for the run, passed to Nextflow as -output-dir. Requires Nextflow 24.10.0 or later and a pipeline that uses workflow outputs. Can be null.
launch.syntaxParser	string	Optional	Nextflow syntax parser version used for the run. One of v1 or v2. Default: v1.
launch.fusionVersion	string	Optional	Fusion version to run the workflow with. Must exist in the system catalog. Applies only when the compute environment enables Fusion v2. Can be null.
launch.nextflowVersion	string	Optional	Nextflow release version to run the workflow with. Must exist in the system catalog and meet the minimum version configured for the compute environment type. Can be null.
launch.commitId	string	Optional	Git commit ID to launch.
launch.pipelineSchemaId	integer	Optional	Pipeline schema identifier to apply to the launch.
UpdateWorkflow			Update workflow
schedRunId	string	Optional	Seqera Scheduler run identifier to record for the workflow. Blank or omitted values leave the stored value unchanged. Once set, the value cannot be changed to a different identifier.
CancelWorkflow			Cancel workflow