Stop an automation

This call stops a running automation.

Request

https://api.sbgenomics.com/v2/automation/runs/{run-id}/actions/stop
https://eu-api.sbgenomics.com/v2/automation/runs/{run-id}/actions/stop

Example request

POST /v2/automation/runs/e5ed2ee7-8f3c-44e9-bc78-4cabd2ee441f/actions/stop
Host: api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl --data-s -H "X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74" -H "content-type: application/json" -X POST "https://api.sbgenomics.com/v2/automation/runs/e5ed2ee7-8f3c-44e9-bc78-4cabd2ee441f/actions/stop"'
from sevenbridges import Api

api = Api(url='https://api.sbgenomics.com/v2',
          token='3259c50e1ac5426ea8f1273259740f74',
          advance_access=True)

run = api.automation_runs.get(id='e5ed2ee7-8f3c-44e9-bc78-4cabd2ee441f')

# send POST request to SB API
run.stop()
run.reload()  # manual reload is needed (v1.0.3)

print(run.status)

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your Seven Bridges Platform authentication token.

Content-Type
required

application/json

X-SBG-Advance-Access
required

advance

Path parameters

In the body, you should enter a list of key-value pairs. The keys, and the values they take, are described in the following table.

Name

Data type

run-id
required

The ID of the automation you are stopping.

Response

See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the response.