Skip to content
Notavia Notavia Docs

Cancel an in-progress run

POST
/v1/workflows/runs/{runId}/cancel
 
curl --request POST \
  --url https://your-notavia-host/v1/workflows/runs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel \
  --header 'Authorization: Bearer <token>'

Transitions the run to Cancelling (or immediately Cancelled if already in a terminal-adjacent state). Any scheduled wait_for_event timeout jobs are cancelled. Running Hangfire step jobs detect the cancellation flag and terminate cleanly.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
runId
required
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Cancellation requested; current status returned.

Media type application/json
object
status
string
Allowed values: cancelling cancelled
Example 
{
  "status": "cancelling"
}

401

Section titled “401 ”

Missing or invalid credentials.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

403

Section titled “403 ”

Credentials do not have the required scope.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

404

Section titled “404 ”

Resource not found.

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
nullable
Example generated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}