Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-07-26162247330.6 KB
Branch

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.

Note: This endpoint is currently in Beta.

post/projects/{project_id}/branches/{branch_id}/finalize_restore

Request body

namestring

used to rename the existing branch when it is replaced. if omitted, a default name is generated and used

Response

OK

Example response

{
  "operations": [
    {
      "id": "d8ac46eb-a757-42b1-9907-f78322ee394e",
      "project_id": "spring-example-302709",
      "branch_id": "br-wispy-meadow-118737",
      "endpoint_id": "ep-silent-smoke-806639",
      "action": "start_compute",
      "status": "finished",
      "failures_count": 0,
      "created_at": "2022-11-15T20:02:00Z",
      "updated_at": "2022-11-15T20:02:02Z",
      "total_duration_ms": 200
    }
  ]
}