Connect to an instance

To interact with a database in an instance within the console, you need to establish a connection.

  1. Go to Import, Explore, Query, or Dashboards.

  2. From the connection status bar, use the dropdown to connect to an instance.

  3. You may need your Username and Password credentials.

connection bar
Figure 1. Connection status bar
connectionmodalnonremote
Figure 2. Connection modal

Connect from external sources

Additionally, you can connect to your instance from various external sources, such as Drivers, Query API, Cypher Shell CLI, Connectors, and other tools. These sources typically require a connection URI, instance user name, and instance password. The URI and credentials can be found in the instance credentials file that you downloaded from the Aura console when your instance was created, as described below.

Connection

Aura connection uses an automated fail over, initially attempting to use neo4j+s:// but switching to https:// if an issue is identified.

The protocol is used for the communication between the Neo4j database server and the client application or tool. The default is neo4j+s//.

The connection method protocol is used for the communication between the Neo4j database server and the client application or tool. For more information about connection schemes, see Operations Manual → Configure network connectors and Bolt Protocol.

neo4j+s://

Establishes a TLS-encrypted connection to Neo4j using the Bolt protocol over WebSockets, with full certificate validation. Use for optimal performance.

https://

TLS encrypted connection to Neo4j over HTTPS (Query API), with full certificate validation. Use in environments where port restrictions may prevent access to the Bolt port.

Connection errors

In an enterprise environment with restrictive networking, connection errors are sometimes caused because non-standard ports (like the Bolt protocol) are ignored, or blocked by firewalls when using neo4j+s://.

Switching to https:// can address connection issues and ensure seamless connectivity without extra configuration.

Instance credentials

When you create an instance in the Aura console, you have the option to download a credential file that contains:

  • Connection URI

  • User name - neo4j by default

  • Password

  • Database name - neo4j by default

  • Instance ID

  • Instance name

You can opt to not download this and just make note of the instance user name and password. However, if you lose this information altogether, there are still options to connect to your instance. These actions require administrative privileges on the project level, (see User management for more information on roles and privileges). If you are not a Project admin, you need to contact your admin to have them perform one of the options.

Option 1 - Create a new user via the Aura console

This option requires that you are able to connect to the instance as a different user with sufficient permissions to create new users on the instance (see User management for more information).

  1. Log into the Aura Console as user with admin privileges.

  2. Go to Query and connect to the instance, as described above.

  3. Use Cypher to create a new user, for example as follows:

    CREATE USER myNewUsername SET PASSWORD 'mySecurePassword' CHANGE NOT REQUIRED

  4. You can now use the new instance username and password to connect to your instance.

Option 2 - Clone to a new instance

This option provides you with a new instance which includes a new connection URI, username, and password.

  1. Log into the Aura Console

  2. From your existing instance, use the […​] to Clone to a new instance. Ensure you save the new credentials file that contains the username and password for your new instance.

  3. Once the new instance is successfully created, use your new credentials to connext to it.