/projects/{project_id}/branches/{branch_id}/restoreRestore branch to a historical state
Restores a branch to an earlier state in its own or another branch's history by specifying an LSN or timestamp. Creates a new branch from the historical state.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/restore" \
-X POST \
-H "Authorization: Bearer $NEON_API_KEY"neon branches restore <id|name>Parameters
project_idThe Neon project ID
branch_idThe branch ID
Request body
1 required Required: source_branch_id.
source_branch_idThe branch_id of the restore source branch.
If source_timestamp and source_lsn are omitted, the branch will be restored to head.
If source_branch_id is equal to the branch's id, source_timestamp or source_lsn is required.
source_lsnA Log Sequence Number (LSN) on the source branch. The branch will be restored with data from this LSN.
source_timestampA timestamp identifying a point in time on the source branch. The branch will be restored with data starting from this point in time.
The timestamp must be provided in ISO 8601 format; for example: 2024-02-26T12:00:00Z.
preserve_under_nameIf not empty, the previous state of the branch will be saved to a branch with this name.
If the branch has children or the source_branch_id is equal to the branch id, this field is required. All existing child branches will be moved to the newly created branch under the name preserve_under_name.
Response
200Updated the specified branch
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.