Migrations

Before starting over: delete what a failed or canceled import created (Migration.discardable: its project, the databases it created and the storage it created for Vercel Blob and Edge Config). The old host is never touched

post/migrations/{migrationId}/discard

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/migrations/{migrationId}/discard
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

migrationIdstring uuid required
Example:3f2b8a4e-5c1d-4e8f-9a7b-2c6d1e0f4a5b

Request body

confirmstring required

the exact name of the import (Migration.name), to confirm that its project and databases are deleted

Response

The import, with result.discarded

idstring uuid required
organizationIdstring uuid required
kind'git' | 'vercel' | 'netlify' | 'heroku' | 'wordpress' | 'database' | 'static-snapshot' | 'cpanel' | 'sftp' | 'php' | 'email' required
state'draft' | 'analyzing' | 'review' | 'importing' | 'verifying' | 'preview_ready' | 'cutover' | 'live' | 'failed' | 'canceled' required
namestring required
sourceobject required

non-secret source summary

projectIdstring uuid nullable required
databaseIdstring uuid nullable required
previewUrlstring nullable required
pushDeploy'github_app' | 'off'

Git-linked imports (git, and vercel/netlify/heroku from a repository): github_app: every push to the branch deploys through the organization's GitHub App installation; off: pushes do not deploy by themselves until the App covers the repository or the project's push-to-deploy webhook is added to it (audit F10)

envLaterstring[]

variables left without a value when the import started (StartMigrationInput.envLater)

envPendingstring[]

GET /migrations/{id}: the envLater variables the project still does not have; set them under its environment variables, then redeploy

valuesExpiredboolean

review: the variable values read from the old host were kept for 24 hours and are gone; analyze again (with a new token) before starting

cancelRequestedboolean required
createdAtstring required

ISO-8601 timestamp

updatedAtstring required

ISO-8601 timestamp

finishedAtstring nullable required

ISO-8601 timestamp

expiresAtstring required

ISO-8601 timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.