Pipelines

A pipeline is a repository containing a Nextflow workflow, a compute environment, and pipeline parameters.

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, computeEnv). Returns an empty value (labels: null, etc.) if omitted.
workspaceId	integer	query	Optional	Workspace identifier.
max	integer	query	Optional	Maximum number of pipelines to return per request.
offset	integer	query	Optional	Number of results to skip for pagination. Default: 0.
sortBy	unknown	query	Optional	Field to sort results by. One of NAME, MODIFIED, or CREATED. Default: NAME.
sortDir	unknown	query	Optional	Sort direction for results. One of ASCENDING or DESCENDING. Default: ASCENDING.
search	string	query	Optional	Free-text search filter to match against pipeline names and descriptions.
visibility	string	query	Optional	Filter pipelines by visibility. One of private, shared, or all.
name	string	query	Optional	Pipeline repository name (e.g., nextflow-io/hello) or full URL.
revision	string	query	Optional	Git revision, branch, or tag to describe. Default: repository default branch.
mainScript	string	query	Optional	Alternative main script filename. Default: main.nf.
orgId	integer	query	Optional	Organization identifier. Used for organization-level validation.
pipelineId	integer	path	Required	Pipeline identifier.
sourceWorkspaceId	integer	query	Optional	Source workspace identifier. Used when accessing a shared pipeline from another workspace.
versionId	string	query	Optional	Pipeline version identifier. If omitted, uses the default version.

Request body parameters

Name	Type	Req/Opt	Description
CreatePipeline			Create pipeline
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	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.
labelIds	array	Optional	Array of label IDs to apply to the pipeline.
version	object	Optional	Request to define a pipeline version.
version.name	string	Optional	Pipeline version name. Maximum 255 characters.
UpdatePipeline			Update pipeline (default 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	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.
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.