Poll a run

GET

migrations

{migration_id}

runs

{run_id}

Poll a run

curl --request GET \
  --url https://app.vern.so/api/v1/migrations/{migration_id}/runs/{run_id} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://app.vern.so/api/v1/migrations/{migration_id}/runs/{run_id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.vern.so/api/v1/migrations/{migration_id}/runs/{run_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.vern.so/api/v1/migrations/{migration_id}/runs/{run_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.vern.so/api/v1/migrations/{migration_id}/runs/{run_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.vern.so/api/v1/migrations/{migration_id}/runs/{run_id}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.vern.so/api/v1/migrations/{migration_id}/runs/{run_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "run_id": "d4c3b2a1-...",
  "status": "running",
  "created_at": "2026-06-19T15:32:11.000Z",
  "message": "Cleaning your data"
}

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.

Response

The run's current state.

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.

Show child attributes

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.

Show child attributes

report

object

Show child attributes

error

string

Present when failed.

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

Poll a run

curl --request GET \
  --url https://app.vern.so/api/v1/migrations/{migration_id}/runs/{run_id} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://app.vern.so/api/v1/migrations/{migration_id}/runs/{run_id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.vern.so/api/v1/migrations/{migration_id}/runs/{run_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.vern.so/api/v1/migrations/{migration_id}/runs/{run_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.vern.so/api/v1/migrations/{migration_id}/runs/{run_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.vern.so/api/v1/migrations/{migration_id}/runs/{run_id}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.vern.so/api/v1/migrations/{migration_id}/runs/{run_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "run_id": "d4c3b2a1-...",
  "status": "running",
  "created_at": "2026-06-19T15:32:11.000Z",
  "message": "Cleaning your data"
}

Overview

Catalog

Migrations

Runs

Export

Authorizations

Path Parameters

Response