API Reference

Authentication

All endpoints (except /api/contact) require authentication. Two options:

• Session cookie: Sign in via the web app — cookies are sent automatically
• API key: Generate from Settings → API Keys. Format: nss_ + 64 hex chars. Include as Authorization: Bearer YOUR_KEY

API keys are shown once at creation. Stored as SHA-256 hashes — they cannot be retrieved after creation. Revoke and regenerate at any time.

Workspaces

If you've accepted a team invite, requests can act on that team's data instead of your own. A session normally operates on your own account; sending a nss_workspace cookie set to another account's id switches every endpoint below to read and write that account's migrations, connections, and webhooks instead. It only ever grants access you already have — a cookie pointing at a workspace you're not an accepted member of is ignored, not rejected. API keys always act as their own owner's account and don't follow this cookie.

Every workspace you can act in — your own, plus any team you've been accepted into — with your role in each.

Body { accountId }. Switches the workspace cookie after checking real membership.

member can view everything and create/run/stop/pause/resume/validate migrations. admin can also manage connections and webhooks, delete or cut over a migration, and share or revoke a report link. Billing and team invites always belong to the real account owner, whichever workspace is active.

Migrations API

List all migrations. Optional query: ?search=&status=&mode=. Returns enriched with source/target connection names.

Create a migration. Required body:

{
  "name": "users-prod-to-pg",
  "sourceConnectionId": "<UUID>",
  "targetConnectionId": "<UUID>",
  "sourceDatabase": "production",
  "sourceCollection": "users",
  "targetTable": "users",
  "mode": "one-time",
  "groupId": "optional-batch-id",
  "groupName": "optional-batch-name"
}

Returns 201 with { id, name, status: "created" }.

Full migration detail — progress, record counts, timestamps, error messages.

Delete a migration. Cannot delete running/queued (returns 409).

Start migration. Requires existing schema mapping. Enqueues BullMQ job. Response: { status: "queued" }.

Stop a running migration. Removes BullMQ job, sets status to stopped.

Pause a running CDC migration. Status → paused.

Resume a paused CDC migration. Uses saved resume token.

Server-Sent Events stream of real-time logs. Connect via EventSource. Sends { done: true } on terminal status.

Update settings. Body (either field): { driftPolicy?: "ignore" | "add_column" | "alert_and_pause", lagAlertThresholdMs?: number | null }. The threshold is 1,000–86,400,000 ms; null turns lag alerts off.

Throughput, lag, error rate and freshness. Returns summary (events/sec over the last 5 minutes, error rate and worst lag over the window), a per-minute series, and the current lagMs and lastEventAt. minutes is 1–1440; metrics are kept for 7 days.

Run validation: row-count parity plus checksum sampling of up to 100 rows. Returns the report and a runId. Each run is stored as a fixed snapshot.

The last 20 validation runs, newest first: { id, createdAt, verdict, label, sharePath }. verdict is passed, failed or incomplete. label is the display text; it reads Counts match for an incomplete run whose row counts matched where row checksums aren't available for that source/target pair.

Download one run as Markdown (format=md, the default) or JSON (format=json).

Create a public read-only link for one run, or return the existing one: { sharePath: "/reports/<token>" }. Anyone with the link can view it without logging in. It shows counts, verdict and mismatched primary keys, never connection details or row values.

Revoke the link. The old URL stops working immediately and is never reissued.

Get saved schema mapping for a migration.

Save/update schema mapping. Body:

{
  "mappings": [
    { "sourceField": "_id", "targetColumn": "id",
      "sqlType": "UUID", "nullable": false, "isPrimaryKey": true },
    { "sourceField": "email", "targetColumn": "email",
      "sqlType": "TEXT", "nullable": true, "isPrimaryKey": false }
  ]
}

Trigger auto schema introspection. Samples 500 docs, returns detected fields + generated DDL.

Connections API

List all connections. Credentials never returned.

Create connection. Body: { name, type, dbType, credentials }. Credentials encrypted with AES-256-GCM.

Update name or credentials. Only provided fields updated.

Delete a connection permanently.

Test connectivity. Returns { ok: true } or { ok: false, message }.

List available databases on the source connection.

List collections/tables in the specified database.

Audit log API

Business and Enterprise plans. Every sign-in, sign-up and change to migrations, connections, API keys, webhooks, team, billing and shared reports, newest first. Each event has the actor, action, target, IP address, user agent, and whether it came from the app or an API key (with the key's prefix). Query: action (prefix, e.g. migration.), from / to (ISO dates), limit (1–100), cursor (from nextCursor). Add format=csv to download up to 50,000 matching rows. Events are append-only, with no edit or delete endpoint, and credential values are never recorded.

Webhooks API

List configured webhooks, with the last 4 characters of each signing secret and the last delivery's time and HTTP status.

Create webhook. URL must be HTTPS. Events: migration.completed, migration.failed, migration.started, cdc.error, cdc.lag_exceeded, cdc.lag_recovered, schema.drift. Returns the endpoint's signing secret once — see Integrations for verifying signatures.

Delete a webhook.

Send test payload to verify endpoint.

Other endpoints

Dashboard stats: active migrations, total records, CDC channels, total migrations.

Get profile (id, name, email).

Update name and/or email.

List API keys (prefix, scope, environment label and last-used time — never raw keys).

Generate new key. Body: name, optional scope (read | write | admin, default admin) and env label. Returns the raw key once. See Integrations for what each scope allows.

Revoke an API key.

List team members.

Invite member by email with role (admin/member).

Remove a team member.

Public (no auth). Submit contact/sales inquiry.

Rate limits

Redis-backed sliding-window rate limiting on all authenticated endpoints:

• Auth endpoints: 10 req / 60s window
• Migrations API: 30 req / 60s
• Connections API: 30 req / 60s
• Webhooks API: 20 req / 60s

Exceeding returns HTTP 429 with Retry-After header.