Skip to main content
See what's recently landed on the Neon backend: Object Storage, Functions, AI Gateway, and more
/Postgres/Overview

Neon Data API

A fully managed REST interface for your Neon database

View as Markdown

The Neon Data API is the HTTP query service in the Neon backend for apps and agents. It provides a secure, stateless interface to your database, letting you access and manage your data directly from web browsers, serverless functions, and edge runtimes using standard HTTP methods. Key benefits include:

  • Browser and edge compatibility. Standard Postgres drivers don't work in web browsers and struggle in edge runtimes, so query from Cloudflare Workers, Vercel Edge, or a browser frontend over standard HTTP.
  • Connectionless scalability. Short-lived HTTP requests replace persistent TCP connections, so you avoid connection pool exhaustion and scale to thousands of concurrent users.
  • Secure by default. The API validates JWTs from any authentication provider and respects PostgreSQL Row-Level Security (RLS) policies, so users only access data they're permitted to see. Use Managed Better Auth, or bring your own provider like Auth0, Clerk, or Firebase.
  • CI/CD integration. Test integrations in isolated branch environments with the Neon Create Branch GitHub Action, which retrieves branch-specific Data API URLs for your workflows.

Secure your data before exposing it

The Data API has no permission layer of its own. Every request is authorized entirely by your PostgreSQL GRANT statements and Row-Level Security (RLS) policies, so a missing or misconfigured policy can expose a table to anyone with the endpoint URL. Before exposing data, follow Access control & security and Secure your app with RLS, and run the Data API advisors to catch misconfigurations.

Not yet HIPAA-compliant

The Data API isn't covered by Neon's HIPAA compliance yet. Don't use it with protected health information (PHI) in a HIPAA-enabled project.

PostgREST compatibility

The Neon Data API is fully compatible with PostgREST. This compatibility allows you to query your database using any standard HTTP client (such as Postman or cURL) or integrate easily using client libraries, including @neon/neon-js and @neon/postgrest-js.

Quickstart

Need help?

Join our Discord Server to ask questions or see what others are doing with Neon. For paid plan support options, see Support.

Last updated on

Was this page helpful?
Edit on GitHub