Initial configuration

The Aura CLI makes heavy use of console commands containing the keyword tenant. To be consistent with that, all Aura CLI documentation pages use the term "tenant", which other parts of the documentation refer to as "project" instead, which is the topological evolution of "tenant".

Obtain an Aura API Key

You must have payment information in your account to access this functionality. This also applies to Aura Free.

Aura Console

  1. Log in to the Neo4j Aura Console. Navigate to the top right where your account name is displayed and use the down arrow to access the account menu.

    unified console account dropdown

  2. Use Create from API Keys in the menu to create a new key.

    unified console api keys

  3. In the pop-up window, enter a name for the client and then Create.

    unified console create api key

  4. Make sure to securely save the generated client ID and client secret as they are required to use the Aura CLI and they are not shown again.

Aura Console classic

  1. Log in to the Neo4j Aura Console.

  2. Navigate to the top right where your account name is displayed and use the down arrow to access the account menu.

    console classic home

  3. Navigate to Account Details.

  4. In the Account Details display, click Create under Aura API and Credentials.

    console classic api keys

  5. In the pop-up window, enter a name for the client and then Create.

  6. Make sure to securely save the generated client ID and client secret as they are required to use the Aura CLI.

Configure the Aura CLI with an Aura API key

Configure the Aura CLI with the Aura API client ID and client secret you obtained earlier. The Aura CLI refers to these as "credentials". You can have several sets of credentials and select which one to use.

  1. At the command prompt, enter the following, using your own values:

    aura-cli credential add --name YOUR\_LABEL --client-id YOUR\_CLIENT\_ID --client-secret YOUR\_CLIENT\_SECRET

  2. To confirm the credentials are working, list your Aura instances:

    aura-cli instance list --output table