Resume a run

Runs a finished run again from from_phase, reusing the output of the phases before it; the run keeps its id. CliqHub sends the request to the run’s daemon, which must be online, and the reviewers chosen at start apply again. The daemon checks the rest (the run is finished, the phase exists, earlier phases have stored output); if it refuses, the run is not resumed and its history shows the request.

Daemons also call this without from_phase to report that a paused run continued.

Requires a realm operator (or higher) with the teams.run permission on the realm that owns the run given by run_id. A daemon’s realm token (cliq_dt_…) from the same realm may also call it.

POST

runs

resume

Resume a run

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

import requests

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

payload = {
    "run_id": "0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f",
    "from_phase": "fix"
}
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', from_phase: 'fix'})
};

fetch('https://{host}/v1/runs/resume', 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/resume",
  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',
    'from_phase' => 'fix'
  ]),
  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/resume"

	payload := strings.NewReader("{\n  \"run_id\": \"0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f\",\n  \"from_phase\": \"fix\"\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/resume")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"run_id\": \"0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f\",\n  \"from_phase\": \"fix\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"from_phase\": \"fix\"\n}"

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

{
  "ok": true,
  "data": {
    "resumed": true,
    "from_phase": "fix"
  }
}

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 resume.

Minimum string length: 1

from_phase

string

Phase to run again from. Without it, this is the daemon reporting that a paused run continued.

Minimum string length: 1

Response

{ resumed, from_phase } with from_phase; true for a daemon report.

enum<boolean>

required

Always true on success.

Available options:

true

data

required

Show child attributes

Resume a run

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

import requests

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

payload = {
    "run_id": "0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f",
    "from_phase": "fix"
}
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', from_phase: 'fix'})
};

fetch('https://{host}/v1/runs/resume', 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/resume",
  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',
    'from_phase' => 'fix'
  ]),
  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/resume"

	payload := strings.NewReader("{\n  \"run_id\": \"0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f\",\n  \"from_phase\": \"fix\"\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/resume")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"run_id\": \"0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f\",\n  \"from_phase\": \"fix\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"from_phase\": \"fix\"\n}"

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

{
  "ok": true,
  "data": {
    "resumed": true,
    "from_phase": "fix"
  }
}

Introduction

System

Auth

Users

Organizations

Invitations

Teams

Realms

Daemons

Workspaces

Runs

Artifacts

Events

Reviews

Notification channels

Notifications

Agents

Settings

Mesh

Jira

A2A

Resume a run

Authorizations

Body

Response