Get Postgres Restore

Report one restore of a channel's database.

A member of the restore's channel reads it. A restore that does not exist, that the 30-day ledger prune removed, whose channel is gone, or whose channel the caller cannot reach answers the same 404 restore_not_found, so the route confirms no other tenant's restore. The route only reads, so it runs on run_read_in_thread.

get/postgres/restores/{restore_id}

Request

Base URL: https://api.xhostd.com (the document declares no server; this is the origin it was published from)
URL: https://api.xhostd.com/postgres/restores/{restore_id}
Auth: none declared

Path parameters

restore_idstring uuid required

Headers

authorizationstring nullable

Response

Successful Response

restore_idstring uuid required

app_idstring uuid required

channel_idstring uuid required

snapshot_idstring uuid required

during_restore'read_only' | 'maintenance' | 'live' required

What the channel's app can do with its database while the restore runs, from the claim to the swap.

read_only: the hold step makes every new transaction of r_<ch32> in ch_<ch32> read-only, so a write fails with SQLSTATE 25006 rather than vanish at the swap. maintenance: the same hold, and the edge serves a page in place of the app (proxy/maintenance.py), the restore's maintenance_channel_id parameter naming a static channel for the page or None for the platform's own. live: the app keeps writing, and the swap discards those writes.

maintenance_channel_idstring uuid nullable required

waitingstring nullable required

queue_aheadinteger nullable required

activitystring nullable required

error_codestring nullable required

messagestring nullable required

noticestring required

submitted_atstring date-time required

started_atstring date-time nullable required

updated_atstring date-time required

finished_atstring date-time nullable required

Changes

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