Cancel a running job
POST
/jobs/{jobId}/runs/{runId}/cancel
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” jobId
required
string
Job definition ID
runId
required
string
Job run ID
Query Parameters
Section titled “Query Parameters ” workspaceId
required
string
Workspace ID
Request Body required
Section titled “Request Body required ”object
id
required
ID of the job run to cancel
string
reason
Reason for cancellation
string
Responses
Section titled “ Responses ”Job run cancelled
object
created_at
required
string format: date-time
created_by
required
string
updated_at
required
string format: date-time
updated_by
required
string
is_soft_deleted
required
boolean
version
required
number
encryption_key_name
required
string
encryption_key_version
number
vault_key_version
number
id
required
Unique job run identifier
string
request_id
required
ID of the trigger request that created this run
string
job_id
required
ID of the job definition
string
workspace_id
required
Workspace containing the job
string
status
required
Current status of the run
string
triggered_by
required
Who or what triggered this run
string
run_label
Optional human-readable label attached at trigger time
string
argo_workflow_name
Argo Workflow resource name for this run
string
started_at
ISO-8601 timestamp when execution started
string
completed_at
ISO-8601 timestamp when execution completed
string
rows_processed
required
Total rows processed
number
rows_matched
required
Total rows matched
number
rows_unmatched
required
Total rows with exceptions
number
error
Error details if status is ERRORED
object
code
required
Machine-readable error code
string
message
required
Human-readable error message
string
details
Additional error details
string
parameters
Runtime parameters for this execution
object
WorkspaceId is required
Run cannot be cancelled in current state