Use Neon as your dev environment for AWS RDS: accelerate your workflow while reducing costs

Neon API

The Neon API allows you to manage your Neon projects programmatically.

Refer to the Neon API reference for supported methods.

The Neon API is a REST API. It provides resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and supports standard HTTP response codes, authentication, and verbs.

Authentication

The Neon API uses API keys to authenticate requests. You can view and manage API keys for your account in the Neon Console. For instructions, refer to Manage API keys.

The client must send an API key in the Authorization header when making requests, using the bearer authentication scheme. For example:

curl 'https://console.neon.tech/api/v2/projects' \
  -H 'Accept: application/json' \
  -H "Authorization: Bearer $NEON_API_KEY" \
  -H 'Content-Type: application/json' \

Neon API base URL

The base URL for a Neon API request is:

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

Append a Neon API method 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}

Using the Neon API reference to construct and execute requests

You can use the Neon API reference to execute Neon API requests. Select an endpoint, enter an API key token in the Bearer field, supply any required parameters and properties, and click Try it! to execute the request. For information about obtaining API keys, see Manage API keys.

The Neon API reference also provides request and response body examples that you can reference when constructing your own requests.

For additional Neon API examples, refer to the following topics:

important

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?

Join our Discord Server to ask questions or see what others are doing with Neon. Users on paid plans can open a support ticket from the console. For more detail, see Getting Support.

Last updated on

Edit this page
Was this page helpful?