/projects/{project_id}/branches/{branch_id}/finalize_restoreFinalize 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.
Note: This endpoint is currently in Beta.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/finalize_restore" \
-X POST \
-H "Authorization: Bearer $NEON_API_KEY"Every field below is optional. An empty body works too.
import { createApiClient } from '@neondatabase/api-client';
const api = createApiClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await api.finalizeRestoreBranch(process.env.PROJECT_ID, process.env.BRANCH_ID);Parameters
project_idThe Neon project ID
branch_idThe branch ID
Request body
No field is required. Send an empty body to use sensible defaults.
nameused to rename the existing branch when it is replaced. if omitted, a default name is generated and used
Response
200OK
Errors
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.