This page will help you get started with the Neon API

Introduction

The Neon API allows you to manage Neon programmatically. With the Neon API, you can create and manage all objects in your Neon account, including:

  • API keys
  • Projects
  • Branches
  • Compute endpoints
  • Databases
  • Roles

πŸ“˜

Databases and roles belong to branches and are therefore managed with Branch endpoints. Look under Branch in the sidebar for database and role endpoints.

For information about the Neon objects listed above, refer to Overview of the Neon object hierarchy, in the Neon documentation.

Neon API base URL

The base URL for a Neon API request is:

https://console.neon.tech/api/v2/

Append a Neon API endpoint path to the base URL to construct the full URL for a request. For example:

https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}

Neon API examples

For Neon API examples, refer to the following topics in the Neon documentation:

πŸ“˜

When using the Neon API programmatically, you can poll the operation status to ensure that an operation is finished before proceeding with the next API request. For more information, see Poll operation status.

Need help?

Send a request to [email protected], or join the Neon community forum.