Restore snapshot

Restores the specified snapshot to a new branch,
and optionally finalizes the restore operation to replace the original branch.

Path Params
string
required
^[a-z0-9-]{1,60}$

The Neon project ID

string
required
^[a-z0-9-]{1,60}$

The snapshot ID

Query Params
string
deprecated

Deprecated. Use the name field in the request body instead. Removal scheduled for November 29, 2025.
A name for the newly restored branch. If omitted, a default name will be generated.

Body Params
string

A name for the newly restored branch. If not provided, the server generates a unique name for the branch automatically.

string

ID of the branch to restore the snapshot into. Defaults to the snapshot's source branch (snapshot.source_branch_id); fails if that cannot be determined.

boolean
Defaults to false

Set to true to finalize the restore operation immediately.
This will complete the restore and move any associated computes to the new branch,
similar to the finalizeRestoreBranch operation.
Defaults to false to allow previewing the restored snapshot data first.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json