Cancel a run - Vern Documentation

PATCH

migrations

{migration_id}

runs

{run_id}

Cancel a run

curl --request PATCH \
  --url https://app.vern.so/api/v1/migrations/{migration_id}/runs/{run_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "status": "cancel_requested"
}
'

{
  "run_id": "d4c3b2a1-...",
  "status": "canceled",
  "created_at": "2026-06-19T15:32:11.000Z"
}

Authorizations

x-api-key

string

header

required

Your Vern API key. Create one at Settings → API keys.

Path Parameters

migration_id

string<uuid>

required

The migration ID returned by Create a migration.

run_id

string<uuid>

required

The run ID returned by Start a run.

Body

application/json

status

enum<string>

required

Available options:

cancel_requested

Response

The run in its updated (canceled) shape.

A run's polled state. Fields beyond run_id/status/created_at depend on status.

run_id

string<uuid>

status

enum<string>

Available options:

queued,

running,

blocked,

awaiting_approval,

completed,

failed,

canceled

created_at

string<date-time>

message

string | null

Present while queued/running.

questions

object[]

Present when blocked.

Show child attributes

report

object

Show child attributes

error

string

Present when failed.

Answer a blocked runResume a run paused at `blocked`. Send `answers` as the structured `[{id,value}]` form (one per question) or a free-form string. Only a blocked run accepts this (409 otherwise).

Cancel a run

curl --request PATCH \
  --url https://app.vern.so/api/v1/migrations/{migration_id}/runs/{run_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "status": "cancel_requested"
}
'

{
  "run_id": "d4c3b2a1-...",
  "status": "canceled",
  "created_at": "2026-06-19T15:32:11.000Z"
}