Cancel a task run

curl --request POST \
  --url https://api.cloud.wherobots.com/task-runs/{taskRunId}/cancel \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cloud.wherobots.com/task-runs/{taskRunId}/cancel"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cloud.wherobots.com/task-runs/{taskRunId}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloud.wherobots.com/task-runs/{taskRunId}/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

API playground

Cancel a task run

Request cancellation of a task run.

Only a run the caller’s organization owns can be cancelled: any other is 404, the same answer as a run that does not exist, and nothing is touched. A finished SCRIPT or Union run with no earlier cancel request returns 409. Repeating an accepted cancel returns 202, including after the run finishes.

The run reads CANCELLING at once while its workload is active. Active workloads stop asynchronously; accepting cancellation does not prove compute has stopped. A run with no workload is finalized CANCELLED at once and kept from starting. A recorded workload reaches CANCELLED through its backend cancellation/destroy events. Script intent is durable; the KubeApp cleaner retries undelivered destroys. A cancel committed before the script’s pre-deploy gate prevents execution. After that gate cancellation is best effort: code may start briefly, and a previously won terminal result stays won.

POST

task-runs

{taskRunId}

cancel

Cancel a task run

curl --request POST \
  --url https://api.cloud.wherobots.com/task-runs/{taskRunId}/cancel \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cloud.wherobots.com/task-runs/{taskRunId}/cancel"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cloud.wherobots.com/task-runs/{taskRunId}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloud.wherobots.com/task-runs/{taskRunId}/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

taskRunId

string

required

The id of the task run.

Response

The cancel was accepted: a run still going reads CANCELLING until the backend confirms it CANCELLED, and a run with nothing started yet reads CANCELLED at once and never starts. Also returned for any repeat of an accepted cancel, including once the run reads CANCELLED; a repeat still pending is dispatched again