Retrieve database schema

Retrieves the database schema. Specify lsn or timestamp (not both) to read at a point in time; omit both to read from the database's head.

Path Params
string
required
^[a-z0-9-]{1,60}$

The Neon project ID

string
required
^[a-z0-9-]{1,60}$

The branch ID

Query Params
string
required

Name of the database for which the schema is retrieved

string

The Log Sequence Number (LSN) for which the schema is retrieved

date-time

The point in time for which the schema is retrieved

string

The format of the schema to retrieve. Possible values:

  • sql (default)
  • json
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json