Sign in
runs

Update Run

Update run properties. Only owner or admin can update.

patch/api/v1/runs/{run_id}

Path parameters

run_idstring uuid required

Run UUID

Run UUID

Request body

visibility'public' | 'private'

Resource visibility options for access control

Response

Successful Response

idstring uuid required
status'PENDING' | 'SETUP' | 'RUNNING' | 'UPLOADING' | 'COMPLETED' | 'FAILED' | 'ERROR' | 'CANCELLED' required

Run status, mirrors Snakedispatch's JobStatus.

visibility'public' | 'private'

Resource visibility options for access control

created_atstring date-time required
started_atstring date-time nullable
completed_atstring date-time nullable
workflowstring required
configfilestring nullable
git_refstring nullable
git_shastring nullable
total_job_countinteger nullable
jobs_finishedinteger nullable
snakemake_argsstring[] nullable
extra_filesobject nullable
import_networksstring[] nullable
callback_urlstring nullable

Changes