Skip to content
Nuon docs

cancel runner job

DELETE
/v1/runner-jobs/{runner_job_id}/cancel

Cancel a runner job.

Authorizations

Parameters

Path Parameters

runner_job_id
required
string

Runner job ID

Request Body

Input

object

Responses

202

Accepted

object
available_timeout

Available timeout is how long a job can be marked as “available” before being requeued

integer
created_at
string
created_by_id
string
execution_count
integer
execution_timeout

Execution timeout is how long a job can be marked as “exeucuting” before being requeued

integer
executions
Array<object>
object
created_at
string
created_by_id
string
id
string
org_id
string
result
object
created_at
string
created_by_id
string
error_code
integer
error_metadata
object
key
additional properties
string
id
string
org_id
string
runner_job_execution_id
string
success

TODO(jm): add richer information on the error or other tied to a job execution.

boolean
updated_at
string
runner_job_id
string
status
string
Allowed values: pending initializing in-progress cleaning-up finished failed timed-out not-attempted cancelled unknown
updated_at
string
group
string
Allowed values: health-checks sync build deploy sandbox runner operations user "" any
id
string
log_stream_id
string
max_executions
integer
operation
string
Allowed values: exec apply destroy plan-only build unknown
org_id
string
overall_timeout

Overall timeout is how long a job can be attempted, before being cancelled

integer
owner_id
string
owner_type
string
queue_timeout

Queue timeout is how long a job can be queued, before being made available

integer
runner_id
string
status
string
Allowed values: queued available in-progress finished failed timed-out not-attempted cancelled unknown
status_description
string
type
string
Allowed values: health-check docker-build container-image-build terraform-module-build helm-chart-build noop-build oci-sync noop-sync terraform-deploy helm-chart-deploy job-deploy noop-deploy shut-down noop sandbox-terraform runner-helm runner-terraform runner-local
updated_at
string

400

Bad Request

object
description
string
error
string
user_error
boolean

401

Unauthorized

object
description
string
error
string
user_error
boolean

403

Forbidden

object
description
string
error
string
user_error
boolean

404

Not Found

object
description
string
error
string
user_error
boolean

500

Internal Server Error

object
description
string
error
string
user_error
boolean