​

Overview

To authenticate with Neon, you need the following:

1. API key – A personal, organization, or project-scoped API key generated from the Neon console.

This guide walks you through creating an API key in the Neon console.

​

Prerequisites

• You must have a Neon account.
• For organization or project-scoped keys, you need the relevant admin permissions.

​

Instructions

​

Step 1: Creating an API key

1. Log in to the Neon console.
2. For a personal key: click your profile in the top-right, then select Account settings → API keys. For an organization or project-scoped key: switch to your organization, then go to Settings → API keys.
3. Click Create new API key (or Create new → Project-scoped for a project key), give it a name, and click Create.
4. Copy the generated API key. Neon only shows it once, so store it securely.

​

Step 2: Enter credentials in the Connect UI

Once you have your API key:

1. Open the form where you need to authenticate with Neon.
2. Enter your API key in its field.
3. Submit the form; you should then be successfully authenticated.

You are now connected to Neon.