Migrations

Vercel review: read a Neon (Vercel Postgres) database's connection string with your Neon API key, so it moves (or stays with its hidden variables filled) without a paste. The key is used for this call only; the connection string is kept encrypted with the import, never returned

post/migrations/{migrationId}/databases/{databaseKey}/connect

Request

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

Path parameters

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

Request body

provider'neon' required
apiKeystring required

Neon API key (console.neon.tech/app/settings/api-keys). Used for this call only; never stored, returned or logged

organizationIdstring

Neon organization id (org-…), when the key sees several

projectIdstring

Neon project id, when the key sees several projects

branchIdstring

default: the project's default branch

databaseNamestring

default: the branch's only database

roleNamestring

default: the database's owner

Response

Connected, or the choices to pick from

state'connected' | 'choose' required

connected: the connection string is kept with the import; choose: pick from the lists and call again

Changes

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