Skip to content

Gets the backup schedule for a project

get/v1/projects/{ref}/database/backups/schedule

OAuth scopes

  • database:read

This endpoint is only available on the following plans:

  • Enterprise

The fine-grained token must include the following permissions to access this endpoint:

  • backups_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 402
  • 403
  • 404
  • 429
  • 500

Response (200)

{
  "schedule_for": "04:00:00",
  "updated_at": "2026-05-04T14:40:44+00:00"
}
{
  "type": "object",
  "properties": {
    "schedule_for": {
      "type": "string",
      "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?$",
      "description": "Time of day to schedule daily backups, in UTC. Format: HH:MM:SS.",
      "example": "04:00:00"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      "description": "Timestamp of when the backup schedule was last updated.",
      "example": "2026-05-04T14:40:44+00:00"
    }
  },
  "required": [
    "schedule_for",
    "updated_at"
  ]
}