Skip to main content
POST
Create or update the source connection

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.

Body

application/json
source_key
string
required

The connector to attach, lower-cased. Unknown or not-yet-enabled keys return 400.

profile_id
string | null

Scope to a profile; null binds to the workbook; omit for the default profile.

config
object

Non-secret connector configuration.

selected_streams
string[] | null

Streams to extract, or null for connector default.

stream_state
object

Incremental-sync cursor state.

credentials
object

Secret values, vaulted and never returned.

Response

The created or updated connection.

source_connection
object

A migration's live API source connection. Never includes secret values; creds_configured reports whether credentials are stored.