Cluster Backups

Set the backup schedule

Sets the daily automatic backup time in UTC, or with null returns it to the start of the cluster's maintenance window.

Required scope: clusters:backups:write

put/clusters/{cluster_id}/backup-schedule

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/clusters/{cluster_id}/backup-schedule
  • Auth: API key in header API-Key

Path parameters

cluster_idstring uuid required

Headers

API-Version'2026-06-01.beta' required

Request body

time_of_daystring required

A time of day in 24-hour UTC, HH:MM.

Example request

{
  "time_of_day": "02:30"
}

Response

The request has succeeded.

time_of_daystring required

A time of day in 24-hour UTC, HH:MM.

source'custom' | 'maintenance_window' required
default_time_of_daystring required

A time of day in 24-hour UTC, HH:MM.

Example response

{
  "time_of_day": "02:30",
  "source": "custom",
  "default_time_of_day": "04:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.