Neo4J integration

Get instance beta

Retrieves details for a specific Neo4j Aura instance using its unique instance ID. Returns comprehensive information including instance name, status, cloud provider, region, memory allocation, connection URL, and other configuration details. Use this action when you need to check the status, configuration, or connection details of a specific Neo4j Aura instance. This is a read-only operation that does not modify any instance state.

Get organization user

Retrieves details of a specific user in a Neo4j Aura organization. Returns user information including email, organization roles, MFA status, last activity, and project-level access permissions. Use this action when you need to inspect user details, verify organization membership, or check user permissions and access levels within an Aura organization.

Get project

Retrieve details of a specific Neo4j Aura project (tenant). Returns project information including its ID, name, and available instance configurations with regions, types, memory, storage options, and cloud providers. Use this action when you need to inspect project details or discover available instance configurations before creating a new Aura instance.

Get project beta

Retrieve details of a specific Neo4j Aura project (tenant) using the v1beta5 API. Returns project information including its ID, name, and available instance configurations with regions, types, memory, storage options, and cloud providers. Use this action when you need to inspect project details or discover available instance configurations before creating a new Aura instance. This uses the v1beta5 API version which may have additional features compared to v1.

Get snapshot

Retrieves details of a specific snapshot for a Neo4j Aura instance. Returns the snapshot profile, current status, and creation timestamp. Use this action when you need to check the status or details of a particular backup snapshot.

List agents

List all agents belonging to a specific Neo4j Aura project. Returns agent information including ID, name, description, database ID, privacy settings, endpoint links, MCP status, and attached tools. Use this action when you need to retrieve all agents for a specific project to identify available agents or to select a specific agent for subsequent operations.

List gds sessions

List all Graph Data Science (GDS) sessions for the authenticated Neo4j Aura account. Returns a summary of each GDS session including status, memory allocation, host information, and expiry date. Use optional filters (instanceId, tenantId, organizationId) to narrow down the results to specific instances or organizational units. Use this action when you need to: - Monitor active GDS sessions and their resource usage - Check session expiry dates to plan for renewals - View host connectivity information for GDS sessions - Audit GDS session creation and status across the organization This action is read-only and does not modify any resources.

List instances beta

Returns a list of Neo4j Aura instances. Use when you need to retrieve all available Neo4j Aura instances in your account, optionally filtered by tenant.

List ip filters

Returns a list of IP filters configured for a Neo4j Aura organization. Use this action when you need to retrieve all IP filters to check which CIDR blocks are allowed or blocked, or to determine which resources are protected by IP filtering.

List projects

List all Aura projects (tenants) available to the authenticated user. Returns a summary of each project including its unique ID and name. Use this action when you need to retrieve all Aura projects to identify which projects are accessible or to select a specific project for subsequent operations.

List project users

List all users in a specific Neo4j Aura project. Returns user information including email, user ID, and project roles for each user. Use this action when you need to retrieve all users associated with a project to identify team members or verify user access levels.

List snapshots

Lists available snapshots for a Neo4j Aura instance. Returns both scheduled and ad-hoc snapshots with their status and creation timestamps. Use when you need to retrieve information about available database backups or recovery points for a specific Aura instance. The date parameter can filter results to a specific day.

Aggregate directors

Executes a directorsAggregate GraphQL query to count directors in Neo4j. Use when you need to get the total count of director records in the database. The GraphQL query returns the count of all directors regardless of pagination.

Create instance beta

Creates a new Neo4j Aura instance with the specified configuration. Use this action when you need to provision a new Neo4j Aura database instance. The operation is asynchronous - the API returns 202 Accepted while the instance is being created in the background. Use this action when you need to create a new Neo4j Aura database instance for your project. The returned credentials (username and password) should be stored securely as they cannot be retrieved again.

Create snapshot

Create an on-demand snapshot of a Neo4j Aura instance. Triggers asynchronous backup creation and returns a snapshot ID that can be used to monitor progress. Use this action when you need to manually create a backup point before major changes or to preserve the current state of your database. Use this action when you want to create an on-demand backup snapshot of your Neo4j Aura instance before performing risky operations like data migrations, schema changes, or bulk updates.

Estimate gds session size

Estimate the size of a new GDS (Graph Data Science) session based on node/relationship counts and algorithm categories. Use this action when you need to determine the appropriate GDS session size before creating a new graph analytics session. This helps ensure you provision sufficient memory for your graph workloads, particularly useful when planning memory allocation for large-scale graph operations like community detection, pathfinding, or similarity algorithms. The estimation considers the number of nodes, relationships, properties, and intended algorithm categories to provide accurate memory recommendations.

Pause instance beta

Pauses a Neo4j Aura instance. Use when you need to temporarily stop an instance to reduce costs or perform maintenance. The instance can be resumed later using the ResumeInstance action. This action is asynchronous - the instance will be in a 'pausing' state until the operation completes. Note: this action cannot be performed if an ongoing operation (such as cloning) is in progress on the instance.

Restore snapshot

Restore a Neo4j Aura instance from a snapshot. Replaces all current data with the snapshot data. This action is irreversible — all data since the snapshot was taken will be permanently lost. Use this action when you need to recover an Aura instance to a previous state from a specific snapshot. This operation cannot be undone once initiated.

Update instance

Updates a Neo4j Aura instance configuration. Allows modifying instance properties such as name, memory allocation, storage size, vector optimization, and graph analytics plugin. Use this action when you need to modify an existing Aura instance's settings or resource allocation. Note: Some operations like memory or storage resizing may trigger an asynchronous update process where the instance status changes to 'updating'. Check the instance status after making changes.

Update instance beta

Edits the configuration of a Neo4j Aura instance. Allows updating the instance name, memory allocation, storage size, and plugin configurations. Use this action when you need to modify an existing Neo4j Aura instance's settings such as renaming the instance, adjusting memory/storage resources, or enabling/disabling the graph analytics plugin or vector optimization features. Note: Some operations like resizing memory or storage may result in a 202 Accepted response indicating the resize request was accepted for async processing.

Update ip filter

Updates an existing IP filter for a Neo4j Aura organization. Use this action when you need to modify an existing IP filter's settings, such as updating its name, description, allow list entries, or enabling/disabling the filter. The request body accepts partial updates - only include the fields you want to modify. This is an idempotent operation that updates the specified properties while preserving all other existing values.