Create snapshot

POST /projects/{project_id}/branches/{branch_id}/snapshot

Creates a snapshot from the specified branch. This operation may initiate an asynchronous process.

Markdown for AI context

curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/snapshot" \
  -X POST \
  -H "Authorization: Bearer $NEON_API_KEY"

Every field below is optional. An empty body works too.

Also available in

neon snapshots create

Project ID

project_id

string

The Neon project ID

Branch ID

branch_id

string

The branch ID

LSN

lsn

string

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

Timestamp

timestamp

string

The target timestamp for the snapshot. Must fall within the restore window. RFC 3339 format. Cannot be used with lsn.

Name

name

string

A name for the snapshot.

Expires at

expires_at

string

The time at which the snapshot will be automatically deleted. RFC 3339 format.

200

Successfully created the snapshot

default

General error

This endpoint can return the standard Neon API error response.

Response fields

• message Required. Human-readable error message.
• code Required. Machine-readable error code.
• request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

Retry guidance

If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.