Skip to main content
PATCH
Cancel a run

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>
answers
object | null

A read-back of your last reply, present once you've answered a block.

message
string | null

Present while queued/running.

blocked_reason
enum<string>

Present when blocked — which kind of block it is.

Available options:
question,
credentials
questions
object[]

Present when blocked for a question.

credential_request
object

Present when a run is blocked for credentials. Describes the live source needing secrets — render a form from schema and POST to .../credentials. Carries no secret values.

report
object
error
string

Present when failed.