Pipeline versions

Pipeline versions allow you to manage multiple versions of a pipeline configuration. Each version represents a distinct snapshot of the pipeline with its own parameters, configuration, and launch settings. You can create, update, and manage versions, including setting a default version for launches.

Path and query parameters

Name	Type	Location	Req/Opt	Description
pipelineId	integer	path	Required	Pipeline numeric identifier.
workspaceId	integer	query	Optional	Workspace numeric identifier.
max	integer	query	Optional	Maximum number of results to return. Default: 20.
offset	integer	query	Optional	Number of results to skip for pagination. Default: 0.
search	string	query	Optional	Filter results by version name. Returns versions containing the search term.
isPublished	boolean	query	Optional	Filter by publication status. Set to true to retrieve published versions, false for draft versions.
name	string	query	Optional	Pipeline version name to validate. Maximum 255 characters.
versionId	string	path	Required	Pipeline version string identifier.

Request body parameters

Name	Type	Req/Opt	Description
UpdatePipelineVersion			Update pipeline version
name	string	Optional	Pipeline name. Must be unique within the workspace.
description	string	Optional	Pipeline description.
icon	string	Optional	Pipeline icon URL.
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.
labelIds	array	Optional	Array of label IDs to assign to the pipeline. If null, empty, or omitted, all existing labels are removed. Label IDs to be preserved must be included in your request.
ManagePipelineVersion			Manage pipeline version
name	string	Optional	New name for the pipeline version. Maximum 255 characters. Cannot be changed if the version is referenced by workflow runs.
isDefault	boolean	Optional	Whether to set this version as the default. Setting to true automatically unsets any previously default version.