Neon API

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

Refer to the Neon API v2 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 the Neon API v2 reference to construct and execute Neon API requests. Click Authorize to add your API key token, and for each method, click Try it out and supply the required parameters and attributes. Click Execute to create and submit the request.

The Neon API v2 reference also provides request and response body examples that you can reference when constructing your own requests. For branching API examples, you can also refer to examples provided in Branching with the Neon API.

Need help?

Send a request to support@neon.tech, or join the Neon community forum.