/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 (e.g., hourly, daily).
Note: This endpoint is currently in Beta.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/backup_schedule" \
-X PUT \
-H "Authorization: Bearer $NEON_API_KEY"import { createApiClient } from '@neondatabase/api-client';
const api = createApiClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await api.setSnapshotSchedule(process.env.PROJECT_ID, process.env.BRANCH_ID);Parameters
project_idThe Neon project ID
branch_idThe branch ID
Request body
1 required Required: schedule.frequency.
scheduleResponse
200Empty response
No example available.
Errors
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
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.