Documentation menu

Restore backup

POSThttps://api.instacloud.com/projects/{projectId}/backups/{backupId}/restore

Token scope: account · org · project — read-only tokens refused (not a GET).

Restore the postgres service root branch to a backup (in-place rollback; requires approval)

Parameters

Name	In	Type	Required
`group`	query	`string`	no
`projectId`	path	`string`	yes
`backupId`	path	`string`	yes

Default Response

Field	Type	Required	Description
`snapshotId`	`string`	no
`activeBranchId`	`string`	no	the project default branch id AFTER restore (changes on finalize_restore)
`backupBranchName`	`string`	no
`finalized`	`boolean`	no

Default Response

Field	Type	Required	Description
`status`	`"approval_required"`	no
`approvalId`	`string`	no
`action`	`string`	no	the gated action, or a comma-joined compound set — prefer `actions`
`actions`	`string[]`	no	every capability this approval covers
`message`	`string`	no
`url`	`string`	no	the console page where a project admin reviews this request
`nextActions`	`object[]`	no
`nextActions.op`	`string`	yes	Neutral logical action id, e.g. "service.add" — NOT an operationId or a CLI/MCP tool name; each client maps it to its own surface.
`nextActions.reason`	`string`	yes	Natural-language, human/LLM-facing "why do this now".
`nextActions.args`	`object`	no	Suggested, flat named arguments; "<placeholder>"s where a value is unknown.
`nextActions.gated`	`boolean`	no	True if the action passes a governance gate.

Default Response

Field	Type	Required	Description
`error`	`string`	yes

Default Response

Field	Type	Required	Description
`error`	`string`	yes

Default Response

Field	Type	Required	Description
`error`	`string`	yes

Default Response

Field	Type	Required	Description
`error`	`string`	yes

Default Response

Field	Type	Required	Description
`error`	`string`	yes