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:
200 OK – no error
Example request - default list:
GET /api/2.0/backupschedulers/?limit=5 HTTP/1.1 Content-Type: application/json
Example response:
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "meta": { "limit": 20, "offset": 0, "total_count": 4 }, "objects": [ { "is_default": false, "is_enabled": true, "meta": {}, "name": "test", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "remote_location": "", "resource_uri": "/api/2.0/backupschedulers/6bcb958f-8c1f-4115-a43e-82c388ee2535/", "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "6bcb958f-8c1f-4115-a43e-82c388ee2535" }, { "is_default": false, "is_enabled": true, "meta": {}, "name": "test", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "remote_location": "", "resource_uri": "/api/2.0/backupschedulers/97fa3587-1187-413b-b9e3-85238276f0ca/", "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "97fa3587-1187-413b-b9e3-85238276f0ca" }, { "is_default": false, "is_enabled": true, "meta": {}, "name": "test", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "remote_location": "", "resource_uri": "/api/2.0/backupschedulers/a3828367-7964-4246-a011-5ff810ecafb6/", "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "a3828367-7964-4246-a011-5ff810ecafb6" }, { "is_default": false, "is_enabled": true, "meta": {}, "name": "test", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "remote_location": "", "resource_uri": "/api/2.0/backupschedulers/f60f5634-201e-499c-a266-dec38e6416bd/", "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "f60f5634-201e-499c-a266-dec38e6416bd" } ] }
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:
200 OK – no error
Example request:
GET /api/2.0/backupschedulers/?type=dr/?limit=5 HTTP/1.1 Content-Type: application/json
Example response:
{ "objects": [ { "grantees": [], "incremental_backup": { "day_of_month": "*", "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "hour": "", "minute": "*", "month": "*", "repeat": { "hour": "", "minute": "*/15" }, "start_time": { "hour": 12, "minute": 0 } }, "initial_backup": { "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "start_time": { "hour": 12, "minute": 0 } }, "is_default": false, "is_enabled": true, "manual_incremental_backup": "", "meta": {}, "name": "test", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "permissions": [], "remote_location": "", "rentention_policy": { "rules": [] }, "resource_uri": "/api/2.0/backupschedulers/f1a7a7d0-944d-4b0a-a6b5-41d3d5402053/", "retention_policy": {}, "tags": [], "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "f1a7a7d0-944d-4b0a-a6b5-41d3d5402053" } ] }
Detailed listing
- GET /backupschedulers/detail/
Gets the detailed list of backup schedulers with additional information to which the authenticated user has access.
- Status Codes:
200 OK – no error
Example request:
GET /api/2.0/backupschedulers/detail/?type=dr Content-Type: application/json
Example response:
{ "meta": { "limit": 20, "offset": 0, "total_count": 6 }, "objects": [ { "grantees": [], "incremental_backup": { "day_of_month": "*", "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "hour": "", "minute": "*", "month": "*", "repeat": { "hour": "", "minute": "*/15" }, "start_time": { "hour": 12, "minute": 0 } }, "initial_backup": { "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "start_time": { "hour": 12, "minute": 0 } }, "is_default": false, "is_enabled": true, "manual_incremental_backup": "", "meta": {}, "name": "test2", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "permissions": [], "remote_location": "", "resource_uri": "/api/2.0/backupschedulers/40c7b699-62c0-412b-9a83-b799f5c0393e/", "retention_policy": {}, "tags": [], "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "40c7b699-62c0-412b-9a83-b799f5c0393e" }, { "grantees": [], "incremental_backup": { "day_of_month": "*", "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "hour": "", "minute": "*", "month": "*", "repeat": { "hour": "", "minute": "*/15" }, "start_time": { "hour": 12, "minute": 0 } }, "initial_backup": { "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "start_time": { "hour": 12, "minute": 0 } }, "is_default": false, "is_enabled": true, "manual_incremental_backup": "", "meta": {}, "name": "test", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "permissions": [], "remote_location": "", "resource_uri": "/api/2.0/backupschedulers/6bcb958f-8c1f-4115-a43e-82c388ee2535/", "retention_policy": {}, "tags": [], "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "6bcb958f-8c1f-4115-a43e-82c388ee2535" }, { "grantees": [], "incremental_backup": { "day_of_month": "*", "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "hour": "", "minute": "*", "month": "*", "repeat": { "hour": "", "minute": "*/15" }, "start_time": { "hour": 12, "minute": 0 } }, "initial_backup": { "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "start_time": { "hour": 12, "minute": 0 } }, "is_default": false, "is_enabled": true, "manual_incremental_backup": "", "meta": {}, "name": "test", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "permissions": [], "remote_location": "", "resource_uri": "/api/2.0/backupschedulers/97fa3587-1187-413b-b9e3-85238276f0ca/", "retention_policy": {}, "tags": [], "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "97fa3587-1187-413b-b9e3-85238276f0ca" }, { "grantees": [], "incremental_backup": { "day_of_month": "*", "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "hour": "", "minute": "*", "month": "*", "repeat": { "hour": "", "minute": "*/15" }, "start_time": { "hour": 12, "minute": 0 } }, "initial_backup": { "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "start_time": { "hour": 12, "minute": 0 } }, "is_default": false, "is_enabled": true, "manual_incremental_backup": "", "meta": {}, "name": "test", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "permissions": [], "remote_location": "", "resource_uri": "/api/2.0/backupschedulers/a3828367-7964-4246-a011-5ff810ecafb6/", "retention_policy": {}, "tags": [], "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "a3828367-7964-4246-a011-5ff810ecafb6" }, { "grantees": [], "incremental_backup": { "day_of_month": "*", "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "hour": "", "minute": "*", "month": "*", "repeat": { "hour": "", "minute": "*/15" }, "start_time": { "hour": 12, "minute": 0 } }, "initial_backup": { "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "start_time": { "hour": 12, "minute": 0 } }, "is_default": false, "is_enabled": true, "manual_incremental_backup": "", "meta": {}, "name": "test", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "permissions": [], "remote_location": "", "resource_uri": "/api/2.0/backupschedulers/f1a7a7d0-944d-4b0a-a6b5-41d3d5402053/", "retention_policy": {}, "tags": [], "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "f1a7a7d0-944d-4b0a-a6b5-41d3d5402053" }, { "grantees": [], "incremental_backup": { "day_of_month": "*", "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "hour": "", "minute": "*", "month": "*", "repeat": { "hour": "", "minute": "*/15" }, "start_time": { "hour": 12, "minute": 0 } }, "initial_backup": { "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "start_time": { "hour": 12, "minute": 0 } }, "is_default": false, "is_enabled": true, "manual_incremental_backup": "", "meta": {}, "name": "test", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "permissions": [], "remote_location": "", "resource_uri": "/api/2.0/backupschedulers/f60f5634-201e-499c-a266-dec38e6416bd/", "retention_policy": {}, "tags": [], "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "f60f5634-201e-499c-a266-dec38e6416bd" } ] }
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:
200 OK – no error
Example request:
GET /api/2.0/backupschedulers/detail/?type=dr Content-Type: application/json
Example response:
{ "meta": { "limit": 20, "offset": 0, "total_count": 6 }, "objects": [ { "grantees": [], "incremental_backup": { "day_of_month": "*", "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "hour": "", "minute": "*", "month": "*", "repeat": { "hour": "", "minute": "*/15" }, "start_time": { "hour": 12, "minute": 0 } }, "initial_backup": { "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "start_time": { "hour": 12, "minute": 0 } }, "is_default": false, "is_enabled": true, "manual_incremental_backup": "", "meta": {}, "name": "test2", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "permissions": [], "remote_location": "", "resource_uri": "/api/2.0/backupschedulers/40c7b699-62c0-412b-9a83-b799f5c0393e/", "retention_policy": {}, "tags": [], "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "40c7b699-62c0-412b-9a83-b799f5c0393e" }, { "grantees": [], "incremental_backup": { "day_of_month": "*", "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "hour": "", "minute": "*", "month": "*", "repeat": { "hour": "", "minute": "*/15" }, "start_time": { "hour": 12, "minute": 0 } }, "initial_backup": { "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "start_time": { "hour": 12, "minute": 0 } }, "is_default": false, "is_enabled": true, "manual_incremental_backup": "", "meta": {}, "name": "test", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "permissions": [], "remote_location": "", "resource_uri": "/api/2.0/backupschedulers/6bcb958f-8c1f-4115-a43e-82c388ee2535/", "retention_policy": {}, "tags": [], "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "6bcb958f-8c1f-4115-a43e-82c388ee2535" }, { "grantees": [], "incremental_backup": { "day_of_month": "*", "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "hour": "", "minute": "*", "month": "*", "repeat": { "hour": "", "minute": "*/15" }, "start_time": { "hour": 12, "minute": 0 } }, "initial_backup": { "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "start_time": { "hour": 12, "minute": 0 } }, "is_default": false, "is_enabled": true, "manual_incremental_backup": "", "meta": {}, "name": "test", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "permissions": [], "remote_location": "", "resource_uri": "/api/2.0/backupschedulers/97fa3587-1187-413b-b9e3-85238276f0ca/", "retention_policy": {}, "tags": [], "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "97fa3587-1187-413b-b9e3-85238276f0ca" }, { "grantees": [], "incremental_backup": { "day_of_month": "*", "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "hour": "", "minute": "*", "month": "*", "repeat": { "hour": "", "minute": "*/15" }, "start_time": { "hour": 12, "minute": 0 } }, "initial_backup": { "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "start_time": { "hour": 12, "minute": 0 } }, "is_default": false, "is_enabled": true, "manual_incremental_backup": "", "meta": {}, "name": "test", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "permissions": [], "remote_location": "", "resource_uri": "/api/2.0/backupschedulers/a3828367-7964-4246-a011-5ff810ecafb6/", "retention_policy": {}, "tags": [], "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "a3828367-7964-4246-a011-5ff810ecafb6" }, { "grantees": [], "incremental_backup": { "day_of_month": "*", "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "hour": "", "minute": "*", "month": "*", "repeat": { "hour": "", "minute": "*/15" }, "start_time": { "hour": 12, "minute": 0 } }, "initial_backup": { "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "start_time": { "hour": 12, "minute": 0 } }, "is_default": false, "is_enabled": true, "manual_incremental_backup": "", "meta": {}, "name": "test", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "permissions": [], "remote_location": "", "resource_uri": "/api/2.0/backupschedulers/f1a7a7d0-944d-4b0a-a6b5-41d3d5402053/", "retention_policy": {}, "tags": [], "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "f1a7a7d0-944d-4b0a-a6b5-41d3d5402053" }, { "grantees": [], "incremental_backup": { "day_of_month": "*", "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "hour": "", "minute": "*", "month": "*", "repeat": { "hour": "", "minute": "*/15" }, "start_time": { "hour": 12, "minute": 0 } }, "initial_backup": { "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "start_time": { "hour": 12, "minute": 0 } }, "is_default": false, "is_enabled": true, "manual_incremental_backup": "", "meta": {}, "name": "test", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "permissions": [], "remote_location": "", "resource_uri": "/api/2.0/backupschedulers/f60f5634-201e-499c-a266-dec38e6416bd/", "retention_policy": {}, "tags": [], "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "f60f5634-201e-499c-a266-dec38e6416bd" } ] }
List single backup scheduler
- GET /backupschedulers/{backupscheduler_uuid}/
Gets detailed information on a backup scheduler identified by backupscheduler_uuid.
- Status Codes:
200 OK – no error
Example request:
GET /api/2.0/backupschedulers/f60f5634-201e-499c-a266-dec38e6416bd Content-Type: application/json
Example response:
{ "grantees": [], "incremental_backup": { "day_of_month": "*", "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "hour": "", "minute": "*", "month": "*", "repeat": { "hour": "", "minute": "*/15" }, "start_time": { "hour": 12, "minute": 0 } }, "initial_backup": { "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "start_time": { "hour": 12, "minute": 0 } }, "is_default": false, "is_enabled": true, "manual_incremental_backup": "", "meta": {}, "name": "test", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "permissions": [], "remote_location": "", "resource_uri": "/api/2.0/backupschedulers/f60f5634-201e-499c-a266-dec38e6416bd/", "retention_policy": {}, "tags": [], "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "f60f5634-201e-499c-a266-dec38e6416bd" }
Creating
- POST /backupschedulers/
Creates a new backup scheduler.
- Status Codes:
201 Created – object created
Example request:
Example response
HTTP/1.1 201 Created Content-Type: application/json; charset=utf-8 { "objects": [ { "grantees": [], "incremental_backup": { "day_of_month": "*", "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "hour": "", "minute": "*", "month": "*", "repeat": { "hour": "", "minute": "*/15" }, "start_time": { "hour": 12, "minute": 0 } }, "initial_backup": { "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "start_time": { "hour": 12, "minute": 0 } }, "is_default": false, "is_enabled": true, "manual_incremental_backup": "", "meta": {}, "name": "test", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "permissions": [], "remote_location": "", "rentention_policy": { "rules": [] }, "resource_uri": "/api/2.0/backupschedulers/f1a7a7d0-944d-4b0a-a6b5-41d3d5402053/", "retention_policy": {}, "tags": [], "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "f1a7a7d0-944d-4b0a-a6b5-41d3d5402053" } ] }
Editing
- PUT /backupschedulers/{backupscheduler_uuid}/
Edits a backup scheduler identified by backupscheduler_uuid.
- Status Codes:
200 OK – no errors
Example request:
GET /api/2.0/backupschedulers/{{dr_uuid}}/ Content-Type: application/json
Example response:
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "grantees": [], "incremental_backup": { "day_of_month": "*", "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "hour": "", "minute": "*", "month": "*", "repeat": { "hour": "", "minute": "*/15" }, "start_time": { "hour": 12, "minute": 0 } }, "initial_backup": { "day_of_week": [ "*" ], "end_time": { "hour": 11, "minute": 45 }, "start_time": { "hour": 12, "minute": 0 } }, "is_default": false, "is_enabled": true, "manual_incremental_backup": "", "meta": {}, "name": "test2", "orchestrator_timezone": "Etc/UTC", "owner": { "resource_uri": "/api/2.0/user/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/", "uuid": "efe6c4a4-d326-4130-a6c4-b1cb267e6b6f" }, "permissions": [], "remote_location": "", "rentention_policy": { "rules": [] }, "resource_uri": "/api/2.0/backupschedulers/40c7b699-62c0-412b-9a83-b799f5c0393e/", "retention_policy": {}, "tags": [], "type": "dr", "user_timezone": "Etc/GMT+12", "uuid": "40c7b699-62c0-412b-9a83-b799f5c0393e" }
Deleting
Single backup scheduler
- DELETE /backupschedulers/{uuid}/
Deletes a single backup scheduler.
- Status Codes:
204 No Content – No content, object deletion started.
Example request:
DELETE /api/2.0/backupschedulers/b4fa47cf-f929-4dde-b77a-ea1d326862bd/ HTTP/1.1 Content-Type: application/json
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:
202 Accepted – Action accepted, execution is proceeding
Example request:
POST /api/2.0/drives/efe6c4a4-d326-4130-a6c4-b1cb267e6b6f/action/?do=set_scheduler HTTP/1.1 Content-Type: application/json
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.