# 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](/guides/apis-sdks-reference-api-snapshots-create-snapshot)

```bash title="REST API - curl"
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

::::tabs
:::tab{title="CLI"}
```bash
neon snapshots create
```
:::

:::tab{title="SDK"}
:::

:::tab{title="Console"}
Console path: Projects → Backup & restore
:::
::::

## Parameters

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.

## Response

200

Successfully created the snapshot

::::tabs
:::tab{title="schema"}
Depth
:::

:::tab{title="example"}
:::
::::

## Errors

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.

## Related pages

- [Delete snapshot](./apis-sdks-reference-api-snapshots-delete-snapshot.md)
- [List project snapshots](./apis-sdks-reference-api-snapshots-list-snapshots.md)
- [Restore snapshot](./apis-sdks-reference-api-snapshots-restore-snapshot.md)
- [Retrieve backup schedule](./apis-sdks-reference-api-snapshots-get-snapshot-schedule.md)
- [Update backup schedule](./apis-sdks-reference-api-snapshots-set-snapshot-schedule.md)
- [Update snapshot](./apis-sdks-reference-api-snapshots-update-snapshot.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.