Update backup schedule

PUT /projects/{project_id}/branches/{branch_id}/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.

Markdown for AI context

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

Also available in

neon snapshots schedule set

Project ID

project_id

string

The Neon project ID

Branch ID

branch_id

string

The branch ID

1 required Required: schedule.frequency.

Schedule

schedule

array

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

200

Empty response

No example available.

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.