neo4j-aura-provisioning-skill

Automate Neo4j Aura instance lifecycle operations via aura-cli and REST API.

101|35|Updated Jan 20, 2026
One-click install
npx skills add https://github.com/neo4j-contrib/neo4j-skills --skill neo4j-aura-provisioning-skill
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: neo4j-aura-provisioning-skill
Source: https://github.com/neo4j-contrib/neo4j-skills/tree/main/neo4j-aura-provisioning-skill
Command: npx skills add https://github.com/neo4j-contrib/neo4j-skills --skill neo4j-aura-provisioning-skill

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill eliminates the error-prone, manual process of creating and managing Neo4j Aura instances by guiding you through authenticated, repeatable provisioning workflows and lifecycle operations.

Core Features & Use Cases

  • Provision Aura instances via CLI and REST: Create instances, select tenant/projects and tier/instance type, and reliably capture connection details and one-time credentials.
  • Manage instance lifecycle: Pause, resume, resize (where supported), and delete with correct async polling and safe state transitions.
  • Automate CI/CD and infrastructure: Generate a Python provisioning flow and align Terraform-based provisioning with instance readiness via polling.
  • Use correct authentication patterns: OAuth2 client-credentials for REST and aura-cli credential setup for CLI workflows.

Quick Start

Tell your agent to provision a Professional Aura instance in region europe-west1 for a specific tenant, download the credentials immediately, poll until the instance is running, and write a local .env file for connecting with Neo4j.

Frequently Asked Questions about neo4j-aura-provisioning-skill

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

FAQPage Schema
How do I automate Neo4j Aura instance provisioning in a CI/CD pipeline?

Automate Neo4j Aura provisioning by using OAuth2 client-credentials for REST API authentication or aura-cli credential setup, then poll instance status asynchronously until the target state is reached. This enables repeatable infrastructure automation for creating and managing database instances.

What is the correct way to handle Neo4j Aura credentials after creating an instance?

Neo4j Aura credentials require immediate secure handling upon instance creation. You must capture the one-time credentials and connection details instantly, then write them to a secure local .env file for connecting with Neo4j.

Can I manage Neo4j Aura lifecycle operations like pause and resume via the REST API?

Neo4j Aura lifecycle operations including pause, resume, resize, and delete are fully supported via the Aura REST API and aura-cli. These operations use safe state transitions with async polling to validate the instance reaches the target status.

Do I need OAuth2 to authenticate with the Neo4j Aura REST API for infrastructure automation?

OAuth2 client-credentials authentication is required to authenticate with the Neo4j Aura REST API for infrastructure automation. For CLI-based workflows, you must complete the aura-cli credential setup instead to securely manage instances.

What's the best way to align Terraform provisioning with Neo4j Aura instance readiness?

Align Terraform provisioning with Neo4j Aura instance readiness by implementing state-validated async polling. Poll the Aura REST API until the instance reaches the running status, ensuring downstream infrastructure resources connect only when the database is fully operational.

Why does my Neo4j Aura provisioning workflow fail during tenant or region selection?

Neo4j Aura provisioning workflows require correct tenant and project selection along with accurate region and instance type parameters. Failing to specify valid tier or type configurations for your target environment causes the REST API or aura-cli request to fail.