VEvern-so
Runs

Cancel a run

Changed on

Cancel an in-flight run. The only accepted body is { "status": "cancel_requested" }.

patch/migrations/{migration_id}/runs/{run_id}

Request

Request body

status'cancel_requested' required

Response

The run in its updated (canceled) shape.

run_idstring uuid
status'queued' | 'running' | 'blocked' | 'awaiting_approval' | 'completed' | 'failed' | 'canceled'
created_atstring date-time
instructionsstring nullable

The guidance given when the migration was generated (at most 200 characters), carried onto every later leg. Null when none was given.

answersobject nullable

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

messagestring nullable

Present while queued/running.

blocked_reason'question' | 'credentials'

Present when blocked — which kind of block it is.

errorstring

Present when failed.

Changes

  • 9293d74a6a03Revision changes
    • info

      added the optional property to the response with the status

  • aaaced6a1cacRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status