pipelines-public

Stop a pipeline run

Stop a pipeline run.

Any jobs which have not yet completed are stopped, including running jobs. Outputs of any completed jobs are saved and may be viewed.

post/api/pipelines/runs/{run_id}/stop

Request

  • Base URL: https://app.tamarind.bio
  • URL: https://app.tamarind.bio/api/pipelines/runs/{run_id}/stop
  • Auth: API key in header x-api-key

Path parameters

run_idstring required

Response

Successful Response

idstring required
templateIdstring required
templateVersionstring nullable required

The executed version handle e.g. 'v1'.

namestring nullable required
source'production' | 'test' required
status'queued' | 'running' | 'finished' | 'partial' | 'stopped' | 'failed' required
startedAtstring required
completedAtstring nullable required
inputsobject required

The recorded inputs (input-node id -> {group} or {file}).

Changes

No recorded changes to this operation across all 1 revision of this API.