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 numeric identifier
max	integer	query	Optional	Pagination max results
offset	integer	query	Optional	Pagination offset
search	string	query	Optional	Filter search parameter
visibility	string	query	Optional	Filter visibility parameter
name	string	query	Optional	Pipeline repository name or URL
revision	string	query	Optional	Pipeline revision
mainScript	string	query	Optional	Pipeline alternative main.nf
orgId	integer	query	Optional	Organization numeric identifier
pipelineId	integer	path	Required	Pipeline numeric identifier
sourceWorkspaceId	integer	query	Optional	Source workspace numeric identifier

Request body parameters

Name	Type	Req/Opt	Description
CreatePipeline			Create pipeline
name	string	Optional
description	string	Optional
icon	string	Optional
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
labelIds	array	Optional
UpdatePipeline			Update pipeline
name	string	Optional
description	string	Optional
icon	string	Optional
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
labelIds	array	Optional