Run a task

post

https://api.sbgenomics.com/v2/tasks/{task_id}/actions/run

This call runs (executes) the specified task. Only tasks whose status is "DRAFT" can be run.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

task_id

string

required

The ID of the task you want to run.

Query Params

fields

array of strings

Selector specifying a subset of fields to include in the response.

fields

batch

boolean

Set this to false to disable the default batching for this task. Running a batch task is a recommended way to run multiple tasks considering the API rate limit (learn more).

use_interruptible_instances

boolean

This field can be true or false. Set this field to true to allow the use of spot instances.

Headers

X-SBG-Auth-Token

string

required

Your Seven Bridges Platform authentication token. For security reasons, token will not be automatically populated in the generated code sample. Please replace <your-token-here> with your token before executing this call.

Content-Type

string

required

Defaults to application/json

Response

Language

Loading…

Response

Choose an example:

application/json

200200