Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(api): document omittedInlineMedia and proxy stripping on export

Yudhi Armyndharisb7f0f485cd2f
diff --git a/docs/06-api-specification.md b/docs/06-api-specification.md
index 41a5cef12..1eacb3f85 100644
--- a/docs/06-api-specification.md
+++ b/docs/06-api-specification.md
@@ -5699,14 +5699,17 @@ The migration set (`MigrationTables`) is, in payload-key order: `sessions`, `web
"statusUpdates": 0,
"automationRules": 0
},
- "skippedTables": []
+ "skippedTables": [],
+ "omittedInlineMedia": { "messages": 0, "messageBatches": 0 }
}
```
-Rows are raw DB column shapes (e.g. `messageBatches` rows use snake_case columns: `batch_id`, `session_id`, `current_index`, `created_at`, …). **`webhooks` rows omit `secret` and `headers`** (webhook credentials are excluded from backups; they restore as `null`/`{}`), while `pluginInstances` rows still carry integration secrets — treat the payload as a credential dump. On Postgres the generated `body_ts` FTS column is stripped from `messages` so archives stay dialect-neutral.
+Rows are raw DB column shapes (e.g. `messageBatches` rows use snake_case columns: `batch_id`, `session_id`, `current_index`, `created_at`, …). **`webhooks` rows omit `secret` and `headers`** (webhook credentials are excluded from backups; they restore as `null`/`{}`), while `pluginInstances` rows still carry integration secrets — treat the payload as a credential dump. **`sessions` rows have any `user:pass` stripped from `proxyUrl`** (a value that does not parse as a URL exports as `null`), so a restored authenticated proxy reads `hasCredentials: false` and fails on the session's next start until the credentials are re-entered with `PATCH /api/sessions/:sessionId/proxy`. On Postgres the generated `body_ts` FTS column is stripped from `messages` so archives stay dialect-neutral.
`sessions`/`webhooks` are queried directly, so a hard DB error there yields `500`. The other 14 are queried tolerantly: a _genuinely missing_ table (an older DB that has not run the migration) exports as `[]` and its name is listed in `skippedTables`; any other error (lock, I/O, timeout) fails the export rather than reporting the table as empty. Check `skippedTables` before restoring — a skipped table is "not migrated yet", not "exported empty".
+`omittedInlineMedia` counts, per table, the inline media payloads the `EXPORT_INLINE_MEDIA_BUDGET_BYTES` budget dropped. Zeroes mean everything fitted; an archive with a non-zero count still restores, but those rows come back without their media.
+
**Errors:** `401` · `403` · `500` DB error
---