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.
workspaceId	integer	query	Optional	Workspace numeric identifier
max	integer	query	Optional	Pagination max results
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
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)

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 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.
CancelWorkflow			Cancel workflow