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"
}
'

200

{
  "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
}

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