Update backup schedule

PUT/projects/{project_id}/branches/{branch_id}/backup_scheduleUpdate backup schedule

Updates the backup schedule for the specified branch. The schedule defines how often automatic snapshots are created (for example, daily or weekly). Requires a paid plan.

Parameters

project_idstringpathrequired

The Neon project ID

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

branch_idstringpathrequired

The branch ID

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

Request body

required

application/json

objectBackupSchedule

schedulearray of objectrequired

List of schedule entries defining the backup frequency. At least one entry is required.

Show child attributes

Show array items

dayinteger

The day of the week or month to take the snapshot (if applicable).

maximum 31 · minimum 1

frequencystringrequired

How often to take snapshots. Known values: `daily`, `weekly`, `monthly`.

hourinteger

The hour of the day to take the snapshot (if applicable).

maximum 23 · minimum 0

monthinteger

The month of the year to take the snapshot (if applicable).

maximum 12 · minimum 1

retention_secondsinteger

How long to keep a scheduled snapshot (in seconds) before it's automatically deleted. The default is 3024000 seconds (35 days), which is also the maximum. Manually created snapshots have no maximum retention: set their `expires_at` instead.

default 3024000 · maximum 3024000 · minimum 3600

Example request

{
  "schedule": [
    {
      "day": 0,
      "frequency": "daily",
      "hour": 0,
      "month": 0,
      "retention_seconds": 3024000
    }
  ]
}

Responses

objectEmptyResponse

Empty response.

Example response

{}

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

branch_idrequiredpath parameter

curl -X PUT 'https://console.neon.tech/api/v2/projects/string/branches/string/backup_schedule' \
  -H 'Content-Type: application/json' \
  -d '{"schedule":[{"day":0,"frequency":"daily","hour":0,"month":0,"retention_seconds":3024000}]}'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/backup_schedule', {
  method: 'PUT',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"schedule":[{"day":0,"frequency":"daily","hour":0,"month":0,"retention_seconds":3024000}]}),
});
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/backup_schedule', { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: "{\"schedule\":[{\"day\":0,\"frequency\":\"daily\",\"hour\":0,\"month\":0,\"retention_seconds\":3024000}]}" });
console.log(await response.json());

import requests

response = requests.request(
    "PUT",
    "https://console.neon.tech/api/v2/projects/string/branches/string/backup_schedule",
    headers={"Content-Type": "application/json"},
    data='{"schedule":[{"day":0,"frequency":"daily","hour":0,"month":0,"retention_seconds":3024000}]}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"schedule":[{"day":0,"frequency":"daily","hour":0,"month":0,"retention_seconds":3024000}]}`)
	req, err := http.NewRequestWithContext(ctx, "PUT", "https://console.neon.tech/api/v2/projects/string/branches/string/backup_schedule", 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/branches/string/backup_schedule");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"schedule\":[{\"day\":0,\"frequency\":\"daily\",\"hour\":0,\"month\":0,\"retention_seconds\":3024000}]}");
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/branches/string/backup_schedule"))
    .method("PUT", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{\"schedule\":[{\"day\":0,\"frequency\":\"daily\",\"hour\":0,\"month\":0,\"retention_seconds\":3024000}]}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/projects/string/branches/string/backup_schedule")
request = Net::HTTPGenericRequest.new("PUT", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"schedule\":[{\"day\":0,\"frequency\":\"daily\",\"hour\":0,\"month\":0,\"retention_seconds\":3024000}]}"
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.Put, "https://console.neon.tech/api/v2/projects/string/branches/string/backup_schedule");
request.Content = new StringContent("{\"schedule\":[{\"day\":0,\"frequency\":\"daily\",\"hour\":0,\"month\":0,\"retention_seconds\":3024000}]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{}

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