Update snapshot | Neon Docs

PATCH/projects/{project_id}/snapshots/{snapshot_id}Update snapshot

Updates the specified snapshot.

Parameters

project_idstringpathrequired

The Neon project ID

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

snapshot_idstringpathrequired

The snapshot ID

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

Request body

required

application/json

objectSnapshotUpdateRequest

snapshotobjectrequired

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

Show child attributes

expires_atnull | string · date-time

The date and time when the snapshot will expire. Omit to leave the current expiration unchanged. Send `null` to clear the expiration so the snapshot never expires. A future timestamp sets the absolute expiration.

namestring

Human-readable label for the snapshot.

Example request

{
  "snapshot": {
    "expires_at": "2030-06-09T18:02:16Z",
    "name": "string"
  }
}

Responses

object

snapshotobjectrequired

Show child attributes

created_atstringrequired

Timestamp when the snapshot was created, in RFC 3339 format (UTC).

diff_sizeinteger · int64

Incremental Postgres storage size in bytes since the previous scheduled snapshot, when the snapshot is billed on incremental (diff) usage. When absent, either the incremental size has not been calculated yet and the snapshot is not being charged, or the snapshot is charged at full logical size (in that case `full_size` is set).

expires_atstring

RFC 3339 timestamp when the snapshot expires and is eligible for deletion. Null if the snapshot does not have an expiry.

full_sizeinteger · int64

Full logical size of the snapshot in bytes at the time it was taken. When absent, the logical size has not been calculated yet and the snapshot is not being charged. When present, a value of 0 means the snapshot is not being charged.

idstringrequired

The snapshot ID.

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

lsnstring

WAL position (Log Sequence Number) at which the snapshot was captured, in Postgres LSN format (for example, `0/3000000`).

manualboolean

True if the snapshot was created manually rather than by a schedule.

namestringrequired

Human-readable label for the snapshot.

slugstring

Snapshot resource ID, unique within the project. Distinct from the internal snapshot ID and display name.

source_branch_idstring

Branch from which this snapshot was created.

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

timestampstring

Point in time captured by the snapshot, in RFC 3339 format (UTC).

Example response

{
  "snapshot": {
    "created_at": "2025-01-15T10:30:00Z",
    "diff_size": 0,
    "expires_at": "string",
    "full_size": 0,
    "id": "string",
    "lsn": "string",
    "manual": true,
    "name": "string",
    "slug": "string",
    "source_branch_id": "string",
    "timestamp": "string"
  }
}

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. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

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.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

snapshot_idrequiredpath parameter

curl -X PATCH 'https://console.neon.tech/api/v2/projects/string/snapshots/string' \
  -H 'Content-Type: application/json' \
  -d '{"snapshot":{"expires_at":"2030-06-09T18:02:16Z","name":"string"}}'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/snapshots/string', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"snapshot":{"expires_at":"2030-06-09T18:02:16Z","name":"string"}}),
});
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/snapshots/string', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"snapshot\":{\"expires_at\":\"2030-06-09T18:02:16Z\",\"name\":\"string\"}}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "https://console.neon.tech/api/v2/projects/string/snapshots/string",
    headers={"Content-Type": "application/json"},
    data='{"snapshot":{"expires_at":"2030-06-09T18:02:16Z","name":"string"}}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"snapshot":{"expires_at":"2030-06-09T18:02:16Z","name":"string"}}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "https://console.neon.tech/api/v2/projects/string/snapshots/string", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/projects/string/snapshots/string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"snapshot\":{\"expires_at\":\"2030-06-09T18:02:16Z\",\"name\":\"string\"}}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/projects/string/snapshots/string"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"snapshot\":{\"expires_at\":\"2030-06-09T18:02:16Z\",\"name\":\"string\"}}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/projects/string/snapshots/string")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"snapshot\":{\"expires_at\":\"2030-06-09T18:02:16Z\",\"name\":\"string\"}}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Patch, "https://console.neon.tech/api/v2/projects/string/snapshots/string");
request.Content = new StringContent("{\"snapshot\":{\"expires_at\":\"2030-06-09T18:02:16Z\",\"name\":\"string\"}}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "snapshot": {
    "created_at": "2025-01-15T10:30:00Z",
    "diff_size": 0,
    "expires_at": "string",
    "full_size": 0,
    "id": "string",
    "lsn": "string",
    "manual": true,
    "name": "string",
    "slug": "string",
    "source_branch_id": "string",
    "timestamp": "string"
  }
}

{
  "code": "",
  "message": "string",
  "request_id": "string"
}