Neon API (unofficial showcase)
POST/projects/{project_id}/branches/{branch_id}/finalize_restore

Finalize a branch restore from a snapshot

Finalizes a branch restore from a snapshot, making the restored branch function as the original branch it replaced. Use this operation only for branches created with restoreSnapshot and finalize_restore set to false; you can optionally provide a replacement name with name. The operation reassigns computes to the restored branch, restarting them, and renames both branches.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 1 body field
project_idstringrequired
The project identifier. Must contain 1 to 60 lowercase letters, digits, or hyphens.
branch_idstringrequired
The branch identifier to finalize. Must contain 1 to 60 lowercase letters, digits, or hyphens.

Optional configuration for naming the replaced branch.

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

2 status codes
200Returns an `operations` array describing the asynchronous actions started to finalize the restore, including their identifiers, actions, statuses, and timing information.
operationsarray<object>required
defaultReturned when a general API error occurs. The response includes a machine-readable `code`, a human-readable `message`, and may include a `request_id`.
request_idstringoptional
Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.
codestringrequired
Machine-readable code classifying the error type. See `message` for a human-readable explanation.
Default:
messagestringrequired
Error message

Error handling

The project_id path parameter and branch_id path parameter must each contain 1 to 60 lowercase letters, digits, or hyphens. The optional name field sets the name for the replaced branch; omit it to generate a unique name.