Neon API (unofficial showcase)
PATCH/projects/{project_id}/snapshots/{snapshot_id}

Update a snapshot

Updates the name or expiration time of a project snapshot. Supply the snapshot object with the fields to change; omitting expires_at leaves the current expiration unchanged, while sending null clears it. A 200 response returns the updated snapshot.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 1 body field
project_idstringrequired
The Neon project ID. Must contain 1–60 lowercase letters, digits, or hyphens.
snapshot_idstringrequired
The snapshot ID. Must contain 1–60 lowercase letters, digits, or hyphens.

Snapshot fields to update.

snapshotobjectrequired
Fields to update on the snapshot. Updatable fields include `name` and `expires_at`.

2 status codes
200Returns the updated snapshot object, including its identifier, name, creation time, and snapshot metadata.
snapshotobjectrequired
defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.
request_idstringoptional
Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.
codestringrequired
Machine-readable code classifying the error type. See `message` for a human-readable explanation.
Default:
messagestringrequired
Error message

Error handling

The snapshot field is required. The project_id path parameter and snapshot_id path parameter must each contain 1–60 lowercase letters, digits, or hyphens; expires_at must be an ISO 8601 date-time when supplied, or null to clear the expiration.