Skip to main content

Module backup

Module backup 

Source
Expand description

Backup capability constants + query builders (04-04, RIG-04) — the gwbk wire: stream down, octet up (04-RESEARCH §Backup endpoints, 83-api postman primary).

GET /data/api/v1/backup?type=roaming answers the portable .gwbk byte stream (Accept: application/octet-stream); the download rides the 03-02 download_to_file pipeline helper VERBATIM (the ONE streaming body-consumption site — no Vec<u8> anywhere on the down path; gwbks are tens of MB, Pitfall 2).

POST /data/api/v1/backup is the RESTORE: the gwbk bytes as a RAW application/octet-stream body — NOT multipart (the postman collection’s exact shape) — with the four scope params sent EXPLICITLY (restoreDisabled, disableTempProjectBackup, renameEnabled, restoreLocal): the server is the authority on defaults, agents see what was sent. Restore is synchronous AND blocks a gateway restart afterward (Pitfall 6), so BOTH directions ride the 300 s per-request class — a short timeout kills mid- restore into unknown state.

Auth: 401 HTML unauthenticated (live-verified shape) — requires a token like every /data route.

Enums§

BackupType
The type query param of the download — roaming = the PORTABLE backup (cross-gateway; the rig snapshot + standalone default), all includes gateway-specific state (07-02’s --type param, research Focus 7: the ONE honest signature change — the baked query const became a builder over this enum).

Constants§

BACKUP_TIMEOUT
Per-request class for BOTH backup directions (Pitfall 6): gwbk generation is not instant, and a restore POST blocks while the gateway restores — a short timeout kills mid-operation into unknown state.