Sign in
runs

Create Run

Submit a new run.

post/api/v1/runs/

Request body

workflowstring required

Git URL of the Snakemake workflow repository to clone and run.

git_refstring nullable

Git branch, tag, or commit SHA to check out. Defaults to the repository's default branch.

configfilestring nullable

Path to a Snakemake config file in the workflow repo.

snakemake_argsstring[] nullable

Additional snakemake arguments appended to the backend's execution defaults. No need to pass own execution defaults like --cores or --profile.

extra_filesobject nullable

Files written into the working directory before execution. Keys are repo-relative paths, values are file contents.

env_varsobject nullable

Environment variables set before execution. Keys are variable names, values are their contents.

import_networksstring[] nullable

Paths of .nc output files to import as networks after the run completes.

backend_idstring uuid nullable

Snakedispatch backend that executes this run. Required when more than one backend is active.

visibility'public' | 'private'

Resource visibility options for access control

callback_urlstring uri nullable

Webhook invoked when the run finishes. Host must match the allowed callback domains setting.

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

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