Skip to main content

Neo4j Integration

Connect Neo4j to enable the AI agent to query your graph database for relationship data, service dependencies, and knowledge graph insights during investigations.

Capabilities

Once connected, the AI agent can:

CapabilityDescription
Cypher QueriesExecute read-only Cypher queries against your graph
Relationship TraversalExplore connections between nodes and entities
Schema DiscoveryBrowse node labels, relationship types, and properties
Dependency MappingTrace service and infrastructure dependencies
note

Read-only access: Only MATCH/RETURN queries are allowed. CREATE, DELETE, SET, MERGE, and other data-modifying commands are blocked.

Prerequisites

  • A Neo4j instance (version 4.x or later recommended)
  • A Neo4j user account with read permissions
  • Network connectivity to the Neo4j HTTP API (port 7474)

Setup

1
Create a Read-Only User
  1. Connect to your Neo4j instance via the browser or CLI
  2. Create a dedicated read-only user:
CREATE USER autoheal SET PASSWORD 'your_secure_password' SET PASSWORD CHANGE NOT REQUIRED;
GRANT ROLE reader TO autoheal;
2
Add Integration in Autoheal
  1. Go to Integrations in Autoheal
  2. Click Neo4j
  3. Enter a name (e.g., "Production Neo4j")
3
Configure Credentials

Enter the following:

  • Neo4j HTTP URL: The HTTP API endpoint (e.g., http://neo4j.example.com:7474)
  • Database: Database name (default: neo4j)
  • Username: Neo4j username
  • Password: Neo4j password
4
Test and Save

Click Test Connection to verify, then Save.

warning

Use the HTTP API endpoint (port 7474), not the Bolt protocol (port 7687). The integration communicates via the Neo4j HTTP API.

Required Permissions

The Neo4j user should have at least these permissions:

PermissionWhy It's Needed
reader roleRead access to all graph data
MATCH privilegeExecute read queries
TRAVERSE privilegeNavigate relationships
tip

Create a dedicated user for Autoheal with only the reader role. Avoid using the admin or neo4j default user.

Example Queries

Once connected, you can ask the AI agent questions like:

Show me all services that depend on the payments microservice
What are the upstream dependencies of the checkout service?
Find all nodes connected to the failing database server
Show the shortest path between the API gateway and the database

Troubleshooting

Connection Refused
  • Verify the HTTP URL and port (7474) are correct
  • Check that Neo4j is running and the HTTP connector is enabled
  • Ensure firewall rules allow connections from Autoheal
  • Do not use bolt:// or port 7687
Authentication Failed
  • Verify the username and password are correct
  • Check that the user account is not locked or expired
  • Ensure password change is not required for the user
No Data Returned
  • Verify the database name is correct (default is neo4j)
  • Check that the user has read access to the target database
  • Ensure the graph contains data matching your query