Restore snapshot

Restore the specified snapshot to a new branch and optionally finalize the restore operation.

Note: This endpoint is currently in Beta.

Path Params
string
required

The Neon project ID

string
required

The snapshot ID

Query Params
string
deprecated

DEPRECATED. Use the name field in the request body instead. 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 omitted, a default name will be generated.

string

The ID of the branch to restore the snapshot into. If not specified, the branch from which the snapshot was originally created (snapshot.source_branch_id) will be used.

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