Skip to content

AuraRestore API Reference

✅ Live-verified 2026-08-01. See Verification status.

While a restore runs, the instance reports status: restoring and its connectionUrl may be briefly unavailable — restore is an instance-level operation, not a database-level one.

The AuraRestore Custom Resource Definition (CRD) restores an AuraInstance in place from one of its snapshots — the Aura equivalent of Neo4jRestore. It is a one-shot action recorded as an auditable object: on completion the CR stays as history and does not re-fire.

Overview

  • API Version: neo4j.neo4j.com/v1beta1
  • Kind: AuraRestore
  • Scope: Namespaced
  • Short name: aurarestore
  • Purpose: One-shot in-place restore of an AuraInstance from a snapshot.
  • Guide: Aura Orchestration Guide

API credentials are resolved from the referenced AuraInstance's provider config. All spec fields are immutable.

Spec

Set exactly one of snapshotId or snapshotRef.

Field Type Description
instanceRef string Required. Immutable. The target AuraInstance (same namespace), restored in place.
snapshotId string Aura snapshot ID to restore from. Immutable. Mutually exclusive with snapshotRef.
snapshotRef string Resolves the snapshot ID from an AuraSnapshot CR in the same namespace. Immutable. Mutually exclusive with snapshotId.

Status

Field Type Description
phase string Restore phase: Pending, Restoring, Completed, Failed.
snapshotId string Snapshot ID actually restored (resolved from snapshotRef when used).
startTime *metav1.Time When the restore was issued to Aura.
completionTime *metav1.Time When the instance returned to Running (or failed).
message string Latest human-readable detail.
conditions []metav1.Condition Standard readiness conditions.
observedGeneration int64 The .metadata.generation last reconciled.

Example

apiVersion: neo4j.neo4j.com/v1beta1
kind: AuraRestore
metadata:
  name: analytics-prod-restore
  namespace: neo4j
spec:
  instanceRef: analytics-prod
  snapshotRef: analytics-prod-adhoc   # or set snapshotId directly