API Documentation

Stop Jobs

POST/api/stop-job

Stop running or queued jobs using the POST API endpoint /stop-job. For batch jobs, all sub-jobs that are running or queued will be stopped.

Required Parameters:

jobName

(string)

Name of the job to stop. Must be provided in the request body as JSON. For batch jobs, provide the parent batch job name to stop all sub-jobs.

Note: Only jobs with status Running or In Queue can be stopped. Jobs that are already Complete, Stopped, or Deleted will return an error.

HTTP Response Status Codes
Status codeDescription
200Job successfully stopped
400Bad request - job not found, not stoppable, or missing parameters
405Method not allowed
1import requests
2
3api_key = "***************"
4headers = {'x-api-key': api_key}
5base_url = "https://app.tamarind.bio/api/"
6
7params = {
8    "jobName": "myJobName"
9}
10response = requests.post(base_url + "stop-job", headers=headers, json=params)
11print(response.json())
Response Format
1{
2  "message": "myJobName stopped",
3  "stoppedCount": 1
4}