Cancel a run

Cancels a running run. When the daemon is online, CliqHub sends it a cancel and the daemon stops the run (mode: queued). When the daemon is offline or a cancel has been waiting more than 5 minutes, CliqHub marks the run cancelled itself (mode: hub_terminated); a daemon that reconnects cannot revive it, but a process still running on that machine is not stopped. A run that has already finished answers mode: already_terminal.

Requires a realm operator (or higher) with the teams.cancel permission on the realm that owns the run given by run_id.

POST

runs

cancel

Cancel a run

curl --request POST \
  --url https://{host}/v1/runs/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "run_id": "0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f",
  "reason": "Wrong branch"
}
'

import requests

url = "https://{host}/v1/runs/cancel"

payload = {
    "run_id": "0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f",
    "reason": "Wrong branch"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({run_id: '0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f', reason: 'Wrong branch'})
};

fetch('https://{host}/v1/runs/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/v1/runs/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'run_id' => '0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f',
    'reason' => 'Wrong branch'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://{host}/v1/runs/cancel"

	payload := strings.NewReader("{\n  \"run_id\": \"0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f\",\n  \"reason\": \"Wrong branch\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/v1/runs/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"run_id\": \"0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f\",\n  \"reason\": \"Wrong branch\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/v1/runs/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"run_id\": \"0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f\",\n  \"reason\": \"Wrong branch\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "data": {
    "cancelled": true,
    "mode": "queued"
  }
}

{
  "ok": false,
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

{
  "ok": false,
  "error": {
    "code": "forbidden",
    "message": "You do not have access to do this"
  }
}

{
  "ok": false,
  "error": {
    "code": "not_found",
    "message": "Not found"
  }
}

{
  "ok": false,
  "error": "run_id: Required",
  "code": "invalid_params"
}

{
  "ok": false,
  "error": "Internal server error",
  "code": "internal_error"
}

Authorizations

Authorization

string

header

required

User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).

Body

application/json

run_id

string

required

The run to cancel.

Minimum string length: 1

reason

string

Why, shown on the run (up to 500 characters).

Maximum string length: 500

Response

Success.

enum<boolean>

required

Always true on success.

Available options:

true

data

object

required

Show child attributes

Cancel a run

curl --request POST \
  --url https://{host}/v1/runs/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "run_id": "0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f",
  "reason": "Wrong branch"
}
'

import requests

url = "https://{host}/v1/runs/cancel"

payload = {
    "run_id": "0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f",
    "reason": "Wrong branch"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({run_id: '0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f', reason: 'Wrong branch'})
};

fetch('https://{host}/v1/runs/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/v1/runs/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'run_id' => '0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f',
    'reason' => 'Wrong branch'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://{host}/v1/runs/cancel"

	payload := strings.NewReader("{\n  \"run_id\": \"0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f\",\n  \"reason\": \"Wrong branch\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/v1/runs/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"run_id\": \"0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f\",\n  \"reason\": \"Wrong branch\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/v1/runs/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"run_id\": \"0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f\",\n  \"reason\": \"Wrong branch\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "data": {
    "cancelled": true,
    "mode": "queued"
  }
}

{
  "ok": false,
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

{
  "ok": false,
  "error": {
    "code": "forbidden",
    "message": "You do not have access to do this"
  }
}

{
  "ok": false,
  "error": {
    "code": "not_found",
    "message": "Not found"
  }
}

{
  "ok": false,
  "error": "run_id: Required",
  "code": "invalid_params"
}

{
  "ok": false,
  "error": "Internal server error",
  "code": "internal_error"
}

Introduction

System

Auth

Users

Organizations

Invitations

Teams

Realms

Daemons

Workspaces

Runs

Artifacts

Events

Reviews

Notification channels

Notifications

Agents

Settings

Mesh

Jira

A2A

Cancel a run

Authorizations

Body

Response