Backup Schedulers

Backup schedulers are a set of rules to automate the creation and deletion of remote snapshots. It is possible to configure a backup scheduler to periodically create remote snapshots , e.g. daily, weekly or monthly. Also, it is possible to configure the retention policy to automate the deletion of the remote snapshots created by the scheduler.

There are three different types of schedulers:

  • dr

  • migration

  • backup

Note

This document is related to backup schedulers only.

Allowed HTTP methods

Method

Description

GET

get / list object/s

POST

create new object/s

PUT

update / modify object/s

DELETE

delete object/s

Note

See RFC 2616#section-9 for more details on HTTP methods semantics.

Listing

GET /backupschedulers/

Gets the list of backup schedulers to which the authenticated user has access.

Parameters:

  • fields – A set of field names specifying the returned fields.

Status Codes:

Example request - default list:

Example response:

Listing schedulers by type

GET /backupschedulers/?type=scheduler_type

Gets the list of backups schedulers to which the authenticated user has access and are from type specified in the filters.

Status Codes:

Example request:

Example response:

Detailed listing

GET /backupschedulers/detail/

Gets the detailed list of backup schedulers with additional information to which the authenticated user has access.

Status Codes:

Example request:

Example response:

Detailed listing schedulers by type

GET /backupschedulers/detail/?type=scheduler_type

Gets the detailed list of backup schedulers to which the authenticated user has access and are from type specified in the filters.

Status Codes:

Example request:

Example response:

List single backup scheduler

GET /backupschedulers/{backupscheduler_uuid}/

Gets detailed information on a backup scheduler identified by backupscheduler_uuid.

Status Codes:

Example request:

Example response:

Creating

POST /backupschedulers/

Creates a new backup scheduler.

Status Codes:

Example request:

Example response

Editing

PUT /backupschedulers/{backupscheduler_uuid}/

Edits a backup scheduler identified by backupscheduler_uuid.

Status Codes:

Example request:

Example response:

Deleting

Single backup scheduler

DELETE /backupschedulers/{uuid}/

Deletes a single backup scheduler.

Status Codes:

Example request:

Example response:

Deletes multiple backup schedulers

DELETE /backupschedulers/

Deletes multiple backup schedulers specified by their UUIDs.

statuscode 204:

No content, object deletion started.

Example request:

Request body

{"objects":
  [
    {
     "uuid":"b137e217-42b6-4ecf-8575-d72efc2d3dbd",
    },
    {
     "uuid":"e035a488-8587-4a15-ab25-9b7343236bc9",
    },
    {
     "uuid":"feded33c-106f-49fa-a1c4-be5c718ad1b5",
    }
  ]
}

Example response:

HTTP/1.0 204 NO CONTENT

Set scheduler to a drive

POST /drives/{drive_uuid}/action/?do=set_scheduler

Link a scheduler to a drive identified by drive_uuid.

Status Codes:

Example request:

Example response

Allowed timezones

The following list are the allowed timezone values for the fields orchestrator_timezone and user_timezone.

Examples of backup schedulers and retention policies

Configure a backup scheduler to create a remote snapshot every 45 minutes and only keep those remote snapshots that were taken in the past 2 days.

Configure a backup scheduler to create a remote snapshot every hour between 20:00 hours to 23:00 hours and only keeps those that were taken in the past 7 days.

Configure a weekly backup scheduler to create a remote snapshot every sunday at 23:00 hours and only keeps those that were taken in the past 4 weeks.

Configure a monthly backup scheduler to create a remote snapshot every first of month at 23:59 hours and only keeps those that were taken in the past 6 months.

Schema