Finalize branch restore from snapshot

Finalize the restore operation for a branch created from a snapshot.
This operation updates the branch so it functions as the original branch it replaced.
This includes:

  • Reassigning any computes from the original branch to the restored branch (this will restart the computes)
  • Renaming the restored branch to the original branch's name
  • Renaming the original branch so it no longer uses the original name

This operation only applies to branches created using the restoreSnapshot endpoint with finalize_restore: false.

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

The Neon project ID

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

The branch ID

Body Params
string

Name for the replaced branch. If omitted, a unique name is generated.

Responses

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