Sign in
Branch

Finalize branch restore from snapshot

Changed on

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.

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

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/finalize_restore
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Request body

namestring

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

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
    }
  ]
}

Changes

  • 97bbba80d23bRevision changes
    • ●

      added the new epc_sync enum value to the // response property for the response status

  • af816419f5e7Revision changes
    • ●

      added the new tenant_attach_safekeepers enum value to the // response property for the response status

    • ●

      added the new tenant_detach_safekeepers enum value to the // response property for the response status