Lineage

Lineage records capture the data flow of Nextflow pipeline runs: the workflow runs, tasks, and files they consume and produce. Each record is identified by a lineage identifier (LID).

Use these endpoints to resolve a workflow run or output file to its LID, search lineage records across the workspaces you can access, retrieve full records or their indexed summaries, and navigate the data flow one hop upstream or downstream.

Path and query parameters

Name	Type	Location	Req/Opt	Description
workspaceId	integer	query	Required	Workspace identifier.
sessionId	string	query	Optional	Nextflow session identifier (UUID) of the workflow run to resolve. Requires runName. Cannot be combined with filePath.
runName	string	query	Optional	Nextflow run name of the workflow run to resolve. Required with sessionId.
filePath	string	query	Optional	Absolute path of the output file to resolve. Cannot be combined with sessionId or runName.
q	string	query	Optional	Tagged-query search string. Scope the search with workspace:{org}/{workspace} (comma-separated for OR, for example workspace:acme/dev,acme/prod) or the numeric workspaceId: alias. Omit both to search every accessible workspace.
pageToken	string	query	Optional	Opaque cursor for the page to return. Omit for the first page. Otherwise, pass the nextPageToken from a previous response for the same query. An invalid token returns 400.
pageSize	integer	query	Optional	Maximum number of results to return per page. Defaults to, and is capped at, the server-side lineage result limit. Default: 1000.
lid	string	path	Required	Lineage record identifier (LID), URL-encoded.
type	string	query	Optional	Filter results by lineage record type. One of FileOutput or TaskRun.