Create snapshot

Create a snapshot from the specified branch using the provided parameters. This endpoint may initiate an asynchronous operation.

Note: This endpoint is currently in Beta.

Path Params
string
required

The Neon project ID

string
required

The branch ID

Query Params
string

The target Log Sequence Number (LSN) to take the snapshot from. Must fall within the restore window. Cannot be used with timestamp

string

The target timestamp for the snapshot. Must fall within the restore window. Use ISO 8601 format (e.g. 2025-08-05T22:00:00Z). Cannot be used with lsn.

string

A name for the snapshot.

string

The time at which the snapshot will be automatically deleted. Use ISO 8601 format (e.g. 2025-08-05T22:00:00Z).

Responses

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