Resume a run from a phase

Runs a finished run again from one phase onwards, reusing the stored output of the phases before it. The run keeps its id and goes back to running; follow it with Stream run events. Use it to retry a failed phase without redoing the work before it.

The run must be finished (completed, failed, cancelled or crashed), the phase must be in the team’s manifest, and every phase before it must have stored output (see has_artifact in List run phases).

From the CLI: cliq run <run> <phase>.

No credential is needed from this machine. From another host, send Authorization: Bearer with a dispatch token CliqHub signed for this daemon or a cliq_tok_… personal token of a user in the daemon’s realm; this only works once the daemon is connected to CliqHub. See Authentication.

POST

runs

resume

Resume a run from a phase

curl --request POST \
  --url http://127.0.0.1:4900/v1/runs/resume \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "run_id": "fix-login-timeout",
  "from_phase": "fix"
}
'

import requests

url = "http://127.0.0.1:4900/v1/runs/resume"

payload = {
    "run_id": "fix-login-timeout",
    "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: 'fix-login-timeout', from_phase: 'fix'})
};

fetch('http://127.0.0.1:4900/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_PORT => "4900",
  CURLOPT_URL => "http://127.0.0.1:4900/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' => 'fix-login-timeout',
    '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 := "http://127.0.0.1:4900/v1/runs/resume"

	payload := strings.NewReader("{\n  \"run_id\": \"fix-login-timeout\",\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("http://127.0.0.1:4900/v1/runs/resume")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"run_id\": \"fix-login-timeout\",\n  \"from_phase\": \"fix\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://127.0.0.1:4900/v1/runs/resume")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"run_id\": \"fix-login-timeout\",\n  \"from_phase\": \"fix\"\n}"

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

{
  "ok": true,
  "data": {
    "run_id": "0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f"
  }
}

Authorizations

Authorization

string

header

required

Not needed from the same machine. From another host: a dispatch JWT CliqHub signed for this daemon, or a cliq_tok_… personal token whose user is in the daemon's realm.

Body

application/json

run_id

required

Run id or run name

from_phase

required

Phase to resume from

{key}

any

Response

Success.

boolean

required

data

object

required

Show child attributes

Resume a run from a phase

curl --request POST \
  --url http://127.0.0.1:4900/v1/runs/resume \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "run_id": "fix-login-timeout",
  "from_phase": "fix"
}
'

import requests

url = "http://127.0.0.1:4900/v1/runs/resume"

payload = {
    "run_id": "fix-login-timeout",
    "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: 'fix-login-timeout', from_phase: 'fix'})
};

fetch('http://127.0.0.1:4900/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_PORT => "4900",
  CURLOPT_URL => "http://127.0.0.1:4900/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' => 'fix-login-timeout',
    '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 := "http://127.0.0.1:4900/v1/runs/resume"

	payload := strings.NewReader("{\n  \"run_id\": \"fix-login-timeout\",\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("http://127.0.0.1:4900/v1/runs/resume")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"run_id\": \"fix-login-timeout\",\n  \"from_phase\": \"fix\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://127.0.0.1:4900/v1/runs/resume")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"run_id\": \"fix-login-timeout\",\n  \"from_phase\": \"fix\"\n}"

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

{
  "ok": true,
  "data": {
    "run_id": "0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f"
  }
}

Introduction

System

Teams

Workspaces

Runs

Artifacts

Agents

Settings

Instances

Daemon

Sign-in

Local tokens

HUG

Hub commands

Resume a run from a phase

Authorizations

Body

Response