neo4j-aura-api

Manage Neo4j Aura cloud instances, snapshots, and cross-instance copies via the v1 REST API.

Updated Jul 24, 2026
One-click install
npx skills add https://github.com/eklyukin/my-ai-config --skill neo4j-aura-api-eklyukin
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: neo4j-aura-api
Source: https://github.com/eklyukin/my-ai-config/tree/main/skills/neo4j-aura-api
Command: npx skills add https://github.com/eklyukin/my-ai-config --skill neo4j-aura-api-eklyukin

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve? Managing Neo4j Aura cloud databases through the web console is manual and slow. This Skill provides programmatic control over Aura instances, backups, and cross-instance data copies through the v1 REST API, including OAuth2 authentication, async operation polling, and Prometheus metrics-based health monitoring. ## Core Features & Use Cases - Instance Lifecycle Management: Create, list, pause, resume, and delete Aura instances using the included Python CLI or direct curl commands. - Backup and Cross-Instance Copy: Create on-demand snapshots, restore from snapshots, and overwrite a destination instance from a source instance for recurring Prod-to-Test refreshes. - Metrics and Health Checks: Fetch Prometheus-format metrics from the customer metrics API and run storage, CPU, heap, and query-latency health checks with remediation guidance. - Use Case: Schedule a weekly job that resumes a scratch test instance, overwrites it with the latest production data in a single API call, and polls until the destination returns to running status. ## Quick Start Set the NEO4J_AURA_CLIENT_ID and NEO4J_AURA_CLIENT_SECRET environment variables, then ask the AI to list all Aura instances and create a snapshot of a specific instance using the aura_api.py script.

Frequently Asked Questions about neo4j-aura-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I authenticate with the Neo4j Aura API?▼

The Aura API uses OAuth2 client credentials, not a static token. Create API credentials in the Aura Console, set NEO4J_AURA_CLIENT_ID and NEO4J_AURA_CLIENT_SECRET, and the aura_api.py script exchanges them for a Bearer token valid for one hour.

How do I copy data between Neo4j Aura instances?▼

Use the overwrite endpoint: POST /v1/instances/{destId}/overwrite with the source instance ID in the body. If you omit the source snapshot ID, Aura takes a fresh snapshot automatically. The destination must be running with storage at least equal to the source's actual store size.

Does the Aura overwrite operation copy indexes and users?▼

No, overwrite copies data only, not indexes or constraints, and it resets the destination's in-DB auth by deleting destination-specific users. After the destination returns to running status, you must recreate application users and replay the schema DDL.

Why does SHOW TRANSACTIONS not find my runaway Neo4j query?▼

SHOW TRANSACTIONS is server-local in an Aura cluster, so a runaway on a secondary is invisible from the leader. Use a read-access session and retry to land on secondaries, or a write-access session to reach the leader where write transactions execute.

How do I monitor Neo4j Aura storage and CPU usage?▼

Fetch Prometheus-format metrics from the customer metrics API endpoint using a separate OAuth2 credential pair. Key metrics include neo4j_database_store_size_database, neo4j_aura_storage_limit, neo4j_aura_cpu_usage, and neo4j_dbms_vm_heap_used_ratio.

What are the limitations of the Aura v1 management API?▼

Snapshot creation and restoration are asynchronous and require polling. Restore is instance-scoped to the same instance, rate limits apply per tier, and overwrite cannot grow destination storage beyond its provisioned size.