Execute a specific migration file by path

POST

https://api.staging.vrtx.sa/testhelpers/databases/migrations/execute

Last modified:2025-12-22 07:00:02

Executes a single migration file from the seed directory. Path format: postgres//file.sql or mongo//file.json. Used by e2e tests to apply specific migrations before test execution.

Request

Body Params application/jsonRequired

Example

{
    "path": "postgres/onboarding/001-seed-test-data.sql"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.staging.vrtx.sa/testhelpers/databases/migrations/execute' \
--header 'Content-Type: application/json' \
--data-raw '{
    "path": "postgres/onboarding/001-seed-test-data.sql"
}'

Responses

🟢200OK

application/json

Migration executed (check success field for result)

Body

Example

{
    "success": true,
    "engine": "POSTGRES",
    "database": "string",
    "path": "string",
    "statements_applied": 0,
    "documents_inserted": 0,
    "error": "string"
}

🟠400Bad Request

Modified at 2025-12-22 07:00:02

Purge and seed all test databases

Run the payouts account topup job once