Stop Job Run

PUT /v1/job-runs/{uuid}/cancel

Stop Job Run

cURL

curl --request PUT \
  --url https://api.dispersed.com/v1/job-runs/{uuid}/cancel \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Cancelled by user"
}
'

import requests

url = "https://api.dispersed.com/v1/job-runs/{uuid}/cancel"

payload = { "reason": "Cancelled by user" }
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'Cancelled by user'})
};

fetch('https://api.dispersed.com/v1/job-runs/{uuid}/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://api.dispersed.com/v1/job-runs/{uuid}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => 'Cancelled by user'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.dispersed.com/v1/job-runs/{uuid}/cancel"

	payload := strings.NewReader("{\n  \"reason\": \"Cancelled by user\"\n}")

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

	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.put("https://api.dispersed.com/v1/job-runs/{uuid}/cancel")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Cancelled by user\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dispersed.com/v1/job-runs/{uuid}/cancel")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"Cancelled by user\"\n}"

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

200

{
  "object": "job_run",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "node_urls": [
    {
      "hostname": "<string>",
      "port": 123,
      "protocol": "<string>",
      "description": "<string>",
      "tls": false
    }
  ],
  "assigned_at_ms": 123,
  "duration_ms": 123,
  "max_timeout_start_ms": 123,
  "billing_rule": "<string>",
  "hourly_rate_usd": 123,
  "job_snapshot": {
    "title": "<string>",
    "uuid": "<string>"
  },
  "uuid": "<string>",
  "prepared_at_ms": 123,
  "started_at_ms": 123,
  "ended_at_ms": 123,
  "max_timeout_run_ms": 123,
  "timeout_run_at_ms": 123,
  "timeout_start_at_ms": 123,
  "prep_hourly_rate_usd": 123,
  "last_billed_at": "2023-11-07T05:31:56Z",
  "next_billing_at": "2023-11-07T05:31:56Z",
  "cancelled_reason": "<string>",
  "failed_reason": "<string>",
  "logs": "<string>",
  "container_access_tokens": [],
  "job_uuid": "<string>",
  "job": "<string>",
  "image_size_bytes": 123
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

Path Parameters

uuid · string<uuid> · required

Body

application/json

reason · string

Example:

"Cancelled by user"

Response

200

application/json

Job run cancelled

object · enum<string> · required

Available options: job_run

created_at · string<date-time> | null · required

updated_at · string<date-time> | null · required

status · enum<string> · required

Available options: ASSIGNED, PREPARING, RUNNING, COMPLETED, CANCELLING, CANCELLED, FAILING, FAILED

node_urls · object[] · required

Show child attributes

assigned_at_ms · number · required

duration_ms · number · required

max_timeout_start_ms · number · required

billing_rule · string · required

hourly_rate_usd · number · required

job_snapshot · object · required

Show child attributes

uuid · string | null

prepared_at_ms · number | null

started_at_ms · number | null

ended_at_ms · number | null

max_timeout_run_ms · number | null

timeout_run_at_ms · number | null

timeout_start_at_ms · number | null

prep_hourly_rate_usd · number

last_billed_at · string<date-time> | null

next_billing_at · string<date-time> | null

cancelled_reason · string | null

failed_reason · string | null

logs · string | null

container_access_tokens · object[]

Show child attributes

job_uuid · string | null

job · string | null

image_size_bytes · number | null