Backup Schedulers
Backup Schedulers automate the creation and deletion of snapshots for your drives. There are two types of snapshots that can be scheduled:
Local Snapshots: Created and stored within the same infrastructure as the original drive. They are fast to create and useful for short-term recovery.
Remote Snapshots: Stored in a different location (data center), making them ideal for disaster recovery or geographic redundancy.
With a scheduler, you can define when snapshots should be created—daily, weekly, monthly, or at custom intervals (e.g. every 12 hours, or only on weekdays). The scheduler ensures snapshots are taken automatically without user intervention.
Each scheduler also includes a retention policy, which defines how long snapshots are kept before being deleted. For example, you might keep daily snapshots for 7 days or monthly ones for 12 months. This ensures your storage doesn’t grow indefinitely and your snapshot history stays clean and manageable.
Schedulers are flexible and can be tailored to your backup and recovery strategy—whether you’re looking for frequent local snapshots for fast rollback, or long-term remote backups for compliance and safety.
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.
- param fields:
A set of field names specifying the returned fields.
- statuscode 200:
no error
Example request - default list:
GET /api/2.0/backupschedulers/ HTTP/1.1
Content-Type: application/json
Authorization: Basic SWYgeW91IGZvdW5kIHRoaXMsIGhhdmUgYSBjb29raWUsIHlvdSBkZXNlcnZlIGl0IDop
Example response:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"meta": {
"limit": 20,
"offset": 0,
"total_count": 9
},
"objects": [
{
"is_default": false,
"is_enabled": true,
"meta": {
},
"name": "BiMonthly Snapshot Policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"remote_location": "TBC",
"resource_uri": "/api/2.0/backupschedulers/14a89b65-c1a4-40e2-b7b2-193214ca1f0e/",
"type": "backup",
"user_timezone": "Etc/UTC",
"uuid": "14a89b65-c1a4-40e2-b7b2-193214ca1f0e"
},
{
"is_default": false,
"is_enabled": true,
"meta": {
},
"name": "Weekdays Workhours Backup Policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"remote_location": "TBC",
"resource_uri": "/api/2.0/backupschedulers/16a910a3-7a04-409a-827e-265b7af8116b/",
"type": "backup",
"user_timezone": "Etc/UTC",
"uuid": "16a910a3-7a04-409a-827e-265b7af8116b"
},
{
"is_default": false,
"is_enabled": true,
"meta": {
},
"name": "Weekday 3AM Snapshot Policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"remote_location": "",
"resource_uri": "/api/2.0/backupschedulers/2aa193d4-6e3f-4545-9de3-27d1cef90a3d/",
"type": "snapshot",
"user_timezone": "Etc/UTC",
"uuid": "2aa193d4-6e3f-4545-9de3-27d1cef90a3d"
},
{
"is_default": false,
"is_enabled": true,
"meta": {
},
"name": "Son, Father, GrandFather Policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"remote_location": "",
"resource_uri": "/api/2.0/backupschedulers/3079a014-1810-4fb6-8395-2a23cb1979e3/",
"type": "snapshot",
"user_timezone": "Etc/GMT+12",
"uuid": "3079a014-1810-4fb6-8395-2a23cb1979e3"
},
{
"is_default": false,
"is_enabled": true,
"meta": {
},
"name": "Every 12 hours. Last 2 days",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"remote_location": "",
"resource_uri": "/api/2.0/backupschedulers/7e39699c-f220-4ee2-b99b-6a678ab51f14/",
"type": "snapshot",
"user_timezone": "Etc/UTC",
"uuid": "7e39699c-f220-4ee2-b99b-6a678ab51f14"
},
{
"is_default": false,
"is_enabled": true,
"meta": {
},
"name": "1st of the month backup",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"remote_location": "TBC",
"resource_uri": "/api/2.0/backupschedulers/876a2d01-9025-431e-81d5-bafbcf0ec26c/",
"type": "backup",
"user_timezone": "Etc/UTC",
"uuid": "876a2d01-9025-431e-81d5-bafbcf0ec26c"
},
{
"is_default": false,
"is_enabled": true,
"meta": {
},
"name": "backups policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"remote_location": "TBC",
"resource_uri": "/api/2.0/backupschedulers/b3a36e0f-4a00-423f-bd3b-8f4b1d1af05f/",
"type": "backup",
"user_timezone": "America/Danmarkshavn",
"uuid": "b3a36e0f-4a00-423f-bd3b-8f4b1d1af05f"
},
{
"is_default": false,
"is_enabled": true,
"meta": {
},
"name": "Defined hours backups",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"remote_location": "",
"resource_uri": "/api/2.0/backupschedulers/ead05317-e67f-4603-9afe-4cb6aab52e52/",
"type": "snapshot",
"user_timezone": "Etc/UTC",
"uuid": "ead05317-e67f-4603-9afe-4cb6aab52e52"
},
{
"is_default": false,
"is_enabled": true,
"meta": {
},
"name": "snapshots policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"remote_location": "TBC",
"resource_uri": "/api/2.0/backupschedulers/eb352f24-3a72-47a9-96cc-7b508ef52d8e/",
"type": "snapshot",
"user_timezone": "America/Danmarkshavn",
"uuid": "eb352f24-3a72-47a9-96cc-7b508ef52d8e"
}
]
}
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.
- statuscode 200:
no error
Example request:
GET /api/2.0/backupschedulers/?type=backup HTTP/1.1
Content-Type: application/json
Authorization: Basic SWYgeW91IGZvdW5kIHRoaXMsIGhhdmUgYSBjb29raWUsIHlvdSBkZXNlcnZlIGl0IDop
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": "BiMonthly Snapshot Policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"remote_location": "TBC",
"resource_uri": "/api/2.0/backupschedulers/14a89b65-c1a4-40e2-b7b2-193214ca1f0e/",
"type": "backup",
"user_timezone": "Etc/UTC",
"uuid": "14a89b65-c1a4-40e2-b7b2-193214ca1f0e"
},
{
"is_default": false,
"is_enabled": true,
"meta": {
},
"name": "Weekdays Workhours Backup Policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"remote_location": "TBC",
"resource_uri": "/api/2.0/backupschedulers/16a910a3-7a04-409a-827e-265b7af8116b/",
"type": "backup",
"user_timezone": "Etc/UTC",
"uuid": "16a910a3-7a04-409a-827e-265b7af8116b"
},
{
"is_default": false,
"is_enabled": true,
"meta": {
},
"name": "1st of the month backup",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"remote_location": "TBC",
"resource_uri": "/api/2.0/backupschedulers/876a2d01-9025-431e-81d5-bafbcf0ec26c/",
"type": "backup",
"user_timezone": "Etc/UTC",
"uuid": "876a2d01-9025-431e-81d5-bafbcf0ec26c"
},
{
"is_default": false,
"is_enabled": true,
"meta": {
},
"name": "backups policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"remote_location": "TBC",
"resource_uri": "/api/2.0/backupschedulers/b3a36e0f-4a00-423f-bd3b-8f4b1d1af05f/",
"type": "backup",
"user_timezone": "America/Danmarkshavn",
"uuid": "b3a36e0f-4a00-423f-bd3b-8f4b1d1af05f"
}
]
}
Detailed listing
- GET /backupschedulers/detail/
Gets the detailed list of backup schedulers with additional information to which the authenticated user has access.
- statuscode 200:
no error
Example request:
GET /api/2.0/backupschedulers/detail/ HTTP/1.1
Content-Type: application/json
Authorization: Basic SWYgeW91IGZvdW5kIHRoaXMsIGhhdmUgYSBjb29raWUsIHlvdSBkZXNlcnZlIGl0IDop
Example response:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"meta": {
"limit": 20,
"offset": 0,
"total_count": 9
},
"objects": [
{
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"grantees": [],
"incremental_backup": {
"day_of_month": "1",
"day_of_week": [
""
],
"end_time": {
"hour": 19,
"minute": 0
},
"hour": "17",
"minute": "0",
"month": [
"2",
"4",
"6",
"8",
"10",
"12"
],
"repeat": {
"hour": "",
"minute": ""
},
"start_time": {
"hour": 7,
"minute": 0
}
},
"initial_backup": {
},
"is_default": false,
"is_enabled": true,
"manual_incremental_backup": "",
"meta": {
},
"name": "BiMonthly Snapshot Policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"permissions": [],
"remote_location": "TBC",
"resource_uri": "/api/2.0/backupschedulers/14a89b65-c1a4-40e2-b7b2-193214ca1f0e/",
"retention_policy": {
"name": "Keep 12 Month",
"rules": [
{
"period": "months",
"quantity": 6
}
]
},
"tags": [],
"type": "backup",
"user_timezone": "Etc/UTC",
"uuid": "14a89b65-c1a4-40e2-b7b2-193214ca1f0e"
},
{
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"grantees": [],
"incremental_backup": {
"day_of_month": "*",
"day_of_week": [
"mon",
"wed",
"fri"
],
"end_time": {
"hour": 19,
"minute": 0
},
"hour": "",
"minute": "",
"month": "*",
"repeat": {
"hour": "*/12",
"minute": ""
},
"start_time": {
"hour": 7,
"minute": 0
}
},
"initial_backup": {
},
"is_default": false,
"is_enabled": true,
"manual_incremental_backup": "",
"meta": {
},
"name": "Weekdays Workhours Backup Policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"permissions": [],
"remote_location": "TBC",
"resource_uri": "/api/2.0/backupschedulers/16a910a3-7a04-409a-827e-265b7af8116b/",
"retention_policy": {
"name": "Keep 1 Month",
"rules": [
{
"period": "months",
"quantity": 1
}
]
},
"tags": [],
"type": "backup",
"user_timezone": "Etc/UTC",
"uuid": "16a910a3-7a04-409a-827e-265b7af8116b"
},
{
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"grantees": [],
"incremental_backup": {
"day_of_month": "*",
"day_of_week": [
"mon",
"tue",
"wed",
"thu",
"fri"
],
"end_time": {
"hour": 11,
"minute": 45
},
"hour": "3",
"minute": "0",
"month": "*",
"repeat": {
"hour": "",
"minute": ""
},
"start_time": {
"hour": 12,
"minute": 0
}
},
"initial_backup": {
},
"is_default": false,
"is_enabled": true,
"manual_incremental_backup": "",
"meta": {
},
"name": "Weekday 3AM Snapshot Policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"permissions": [],
"remote_location": "",
"resource_uri": "/api/2.0/backupschedulers/2aa193d4-6e3f-4545-9de3-27d1cef90a3d/",
"retention_policy": {
"name": "Keep 3 Weeks",
"rules": [
{
"period": "weeks",
"quantity": 3
}
]
},
"tags": [],
"type": "snapshot",
"user_timezone": "Etc/UTC",
"uuid": "2aa193d4-6e3f-4545-9de3-27d1cef90a3d"
},
{
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"grantees": [],
"incremental_backup": {
"day_of_month": "*",
"day_of_week": [
"*"
],
"end_time": {
"hour": 11,
"minute": 45
},
"hour": "1",
"minute": "0",
"month": "*",
"repeat": {
"hour": "",
"minute": ""
},
"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": "Son, Father, GrandFather Policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"permissions": [],
"remote_location": "",
"resource_uri": "/api/2.0/backupschedulers/3079a014-1810-4fb6-8395-2a23cb1979e3/",
"retention_policy": {
"name": "Son, Father, GrandFather Policy",
"rules": [
{
"period": "days",
"quantity": 7
},
{
"period": "weeks",
"quantity": 4
},
{
"time_option": 1
},
{
"period": "months",
"quantity": 12
},
{
"time_option": 23
}
]
},
"tags": [],
"type": "snapshot",
"user_timezone": "Etc/GMT+12",
"uuid": "3079a014-1810-4fb6-8395-2a23cb1979e3"
},
{
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"grantees": [],
"incremental_backup": {
"day_of_month": "",
"day_of_week": [
""
],
"end_time": {
"hour": 6,
"minute": 45
},
"hour": "",
"minute": "",
"month": "",
"repeat": {
"hour": "*/12",
"minute": ""
},
"start_time": {
"hour": 7,
"minute": 0
}
},
"initial_backup": {
},
"is_default": false,
"is_enabled": true,
"manual_incremental_backup": "",
"meta": {
},
"name": "Every 12 hours. Last 2 days",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"permissions": [],
"remote_location": "",
"resource_uri": "/api/2.0/backupschedulers/7e39699c-f220-4ee2-b99b-6a678ab51f14/",
"retention_policy": {
"name": "Keep 12 Month",
"rules": [
{
"period": "days",
"quantity": 2
}
]
},
"tags": [],
"type": "snapshot",
"user_timezone": "Etc/UTC",
"uuid": "7e39699c-f220-4ee2-b99b-6a678ab51f14"
},
{
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"grantees": [],
"incremental_backup": {
"day_of_month": "1",
"day_of_week": [
""
],
"end_time": {
"hour": 6,
"minute": 45
},
"hour": "23",
"minute": "0",
"month": "",
"repeat": {
"hour": "",
"minute": ""
},
"start_time": {
"hour": 7,
"minute": 0
}
},
"initial_backup": {
},
"is_default": false,
"is_enabled": true,
"manual_incremental_backup": "",
"meta": {
},
"name": "1st of the month backup",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"permissions": [],
"remote_location": "TBC",
"resource_uri": "/api/2.0/backupschedulers/876a2d01-9025-431e-81d5-bafbcf0ec26c/",
"retention_policy": {
"name": "Keep 12 Month",
"rules": [
{
"period": "months",
"quantity": 12
}
]
},
"tags": [],
"type": "backup",
"user_timezone": "Etc/UTC",
"uuid": "876a2d01-9025-431e-81d5-bafbcf0ec26c"
},
{
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"grantees": [],
"incremental_backup": {
"day_of_month": "*",
"day_of_week": [
"*"
],
"end_time": {
"hour": 23,
"minute": 45
},
"hour": "",
"minute": "*",
"month": "*",
"repeat": {
"hour": "*/1",
"minute": ""
},
"start_time": {
"hour": 0,
"minute": 0
}
},
"initial_backup": {
"day_of_week": [
"*"
],
"end_time": {
"hour": 23,
"minute": 45
},
"start_time": {
"hour": 0,
"minute": 0
}
},
"is_default": false,
"is_enabled": true,
"manual_incremental_backup": "",
"meta": {
},
"name": "backups policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"permissions": [],
"remote_location": "TBC",
"resource_uri": "/api/2.0/backupschedulers/b3a36e0f-4a00-423f-bd3b-8f4b1d1af05f/",
"retention_policy": {
"name": "Last 2 days",
"rules": [
{
"period": "days",
"quantity": 2
}
]
},
"tags": [],
"type": "backup",
"user_timezone": "America/Danmarkshavn",
"uuid": "b3a36e0f-4a00-423f-bd3b-8f4b1d1af05f"
},
{
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"grantees": [],
"incremental_backup": {
"day_of_month": "",
"day_of_week": [
"sat",
"sun"
],
"end_time": {
"hour": 6,
"minute": 45
},
"hour": "",
"minute": "",
"month": "",
"repeat": {
"hour": "",
"minute": ""
},
"start_time": {
"hour": 7,
"minute": 0
}
},
"initial_backup": {
},
"is_default": false,
"is_enabled": true,
"manual_incremental_backup": "02:00,06:00,20:00,22:15",
"meta": {
},
"name": "Defined hours backups",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"permissions": [],
"remote_location": "",
"resource_uri": "/api/2.0/backupschedulers/ead05317-e67f-4603-9afe-4cb6aab52e52/",
"retention_policy": {
"name": "Keep 1 Day",
"rules": [
{
"period": "months",
"quantity": 1
}
]
},
"tags": [],
"type": "snapshot",
"user_timezone": "Etc/UTC",
"uuid": "ead05317-e67f-4603-9afe-4cb6aab52e52"
},
{
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"grantees": [],
"incremental_backup": {
"day_of_month": "*",
"day_of_week": [
"*"
],
"end_time": {
"hour": 23,
"minute": 45
},
"hour": "",
"minute": "*",
"month": "*",
"repeat": {
"hour": "*/2",
"minute": ""
},
"start_time": {
"hour": 0,
"minute": 0
}
},
"initial_backup": {
"day_of_week": [
"*"
],
"end_time": {
"hour": 23,
"minute": 45
},
"start_time": {
"hour": 0,
"minute": 0
}
},
"is_default": false,
"is_enabled": true,
"manual_incremental_backup": "",
"meta": {
},
"name": "snapshots policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"permissions": [],
"remote_location": "TBC",
"resource_uri": "/api/2.0/backupschedulers/eb352f24-3a72-47a9-96cc-7b508ef52d8e/",
"retention_policy": {
"name": "Last 3 days",
"rules": [
{
"period": "days",
"quantity": 3
}
]
},
"tags": [],
"type": "snapshot",
"user_timezone": "America/Danmarkshavn",
"uuid": "eb352f24-3a72-47a9-96cc-7b508ef52d8e"
}
]
}
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.
- statuscode 200:
no error
Example request:
GET /api/2.0/backupschedulers/detail/?type=snapshot HTTP/1.1
Content-Type: application/json
Authorization: Basic SWYgeW91IGZvdW5kIHRoaXMsIGhhdmUgYSBjb29raWUsIHlvdSBkZXNlcnZlIGl0IDop
Example response:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"meta": {
"limit": 20,
"offset": 0,
"total_count": 5
},
"objects": [
{
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"grantees": [],
"incremental_backup": {
"day_of_month": "*",
"day_of_week": [
"mon",
"tue",
"wed",
"thu",
"fri"
],
"end_time": {
"hour": 11,
"minute": 45
},
"hour": "3",
"minute": "0",
"month": "*",
"repeat": {
"hour": "",
"minute": ""
},
"start_time": {
"hour": 12,
"minute": 0
}
},
"initial_backup": {
},
"is_default": false,
"is_enabled": true,
"manual_incremental_backup": "",
"meta": {
},
"name": "Weekday 3AM Snapshot Policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"permissions": [],
"remote_location": "",
"resource_uri": "/api/2.0/backupschedulers/2aa193d4-6e3f-4545-9de3-27d1cef90a3d/",
"retention_policy": {
"name": "Keep 3 Weeks",
"rules": [
{
"period": "weeks",
"quantity": 3
}
]
},
"tags": [],
"type": "snapshot",
"user_timezone": "Etc/UTC",
"uuid": "2aa193d4-6e3f-4545-9de3-27d1cef90a3d"
},
{
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"grantees": [],
"incremental_backup": {
"day_of_month": "*",
"day_of_week": [
"*"
],
"end_time": {
"hour": 11,
"minute": 45
},
"hour": "1",
"minute": "0",
"month": "*",
"repeat": {
"hour": "",
"minute": ""
},
"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": "Son, Father, GrandFather Policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"permissions": [],
"remote_location": "",
"resource_uri": "/api/2.0/backupschedulers/3079a014-1810-4fb6-8395-2a23cb1979e3/",
"retention_policy": {
"name": "Son, Father, GrandFather Policy",
"rules": [
{
"period": "days",
"quantity": 7
},
{
"period": "weeks",
"quantity": 4
},
{
"time_option": 1
},
{
"period": "months",
"quantity": 12
},
{
"time_option": 23
}
]
},
"tags": [],
"type": "snapshot",
"user_timezone": "Etc/GMT+12",
"uuid": "3079a014-1810-4fb6-8395-2a23cb1979e3"
},
{
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"grantees": [],
"incremental_backup": {
"day_of_month": "",
"day_of_week": [
""
],
"end_time": {
"hour": 6,
"minute": 45
},
"hour": "",
"minute": "",
"month": "",
"repeat": {
"hour": "*/12",
"minute": ""
},
"start_time": {
"hour": 7,
"minute": 0
}
},
"initial_backup": {
},
"is_default": false,
"is_enabled": true,
"manual_incremental_backup": "",
"meta": {
},
"name": "Every 12 hours. Last 2 days",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"permissions": [],
"remote_location": "",
"resource_uri": "/api/2.0/backupschedulers/7e39699c-f220-4ee2-b99b-6a678ab51f14/",
"retention_policy": {
"name": "Keep 12 Month",
"rules": [
{
"period": "days",
"quantity": 2
}
]
},
"tags": [],
"type": "snapshot",
"user_timezone": "Etc/UTC",
"uuid": "7e39699c-f220-4ee2-b99b-6a678ab51f14"
},
{
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"grantees": [],
"incremental_backup": {
"day_of_month": "",
"day_of_week": [
"sat",
"sun"
],
"end_time": {
"hour": 6,
"minute": 45
},
"hour": "",
"minute": "",
"month": "",
"repeat": {
"hour": "",
"minute": ""
},
"start_time": {
"hour": 7,
"minute": 0
}
},
"initial_backup": {
},
"is_default": false,
"is_enabled": true,
"manual_incremental_backup": "02:00,06:00,20:00,22:15",
"meta": {
},
"name": "Defined hours backups",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"permissions": [],
"remote_location": "",
"resource_uri": "/api/2.0/backupschedulers/ead05317-e67f-4603-9afe-4cb6aab52e52/",
"retention_policy": {
"name": "Keep 1 Day",
"rules": [
{
"period": "months",
"quantity": 1
}
]
},
"tags": [],
"type": "snapshot",
"user_timezone": "Etc/UTC",
"uuid": "ead05317-e67f-4603-9afe-4cb6aab52e52"
},
{
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"grantees": [],
"incremental_backup": {
"day_of_month": "*",
"day_of_week": [
"*"
],
"end_time": {
"hour": 23,
"minute": 45
},
"hour": "",
"minute": "*",
"month": "*",
"repeat": {
"hour": "*/2",
"minute": ""
},
"start_time": {
"hour": 0,
"minute": 0
}
},
"initial_backup": {
"day_of_week": [
"*"
],
"end_time": {
"hour": 23,
"minute": 45
},
"start_time": {
"hour": 0,
"minute": 0
}
},
"is_default": false,
"is_enabled": true,
"manual_incremental_backup": "",
"meta": {
},
"name": "snapshots policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"permissions": [],
"remote_location": "TBC",
"resource_uri": "/api/2.0/backupschedulers/eb352f24-3a72-47a9-96cc-7b508ef52d8e/",
"retention_policy": {
"name": "Last 3 days",
"rules": [
{
"period": "days",
"quantity": 3
}
]
},
"tags": [],
"type": "snapshot",
"user_timezone": "America/Danmarkshavn",
"uuid": "eb352f24-3a72-47a9-96cc-7b508ef52d8e"
}
]
}
List single backup scheduler
- GET /backupschedulers/{backupscheduler_uuid}/
Gets detailed information on a backup scheduler identified by backupscheduler_uuid.
- statuscode 200:
no error
Example request:
GET /api/2.0/backupschedulers/eb352f24-3a72-47a9-96cc-7b508ef52d8e/ HTTP/1.1
Content-Type: application/json
Authorization: Basic SWYgeW91IGZvdW5kIHRoaXMsIGhhdmUgYSBjb29raWUsIHlvdSBkZXNlcnZlIGl0IDop
Example response:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"grantees": [],
"incremental_backup": {
"day_of_month": "*",
"day_of_week": [
"*"
],
"end_time": {
"hour": 23,
"minute": 45
},
"hour": "",
"minute": "*",
"month": "*",
"repeat": {
"hour": "*/2",
"minute": ""
},
"start_time": {
"hour": 0,
"minute": 0
}
},
"initial_backup": {
"day_of_week": [
"*"
],
"end_time": {
"hour": 23,
"minute": 45
},
"start_time": {
"hour": 0,
"minute": 0
}
},
"is_default": false,
"is_enabled": true,
"manual_incremental_backup": "",
"meta": {
},
"name": "snapshots policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"permissions": [],
"remote_location": "TBC",
"resource_uri": "/api/2.0/backupschedulers/eb352f24-3a72-47a9-96cc-7b508ef52d8e/",
"retention_policy": {
"name": "Last 3 days",
"rules": [
{
"period": "days",
"quantity": 3
}
]
},
"tags": [],
"type": "snapshot",
"user_timezone": "America/Danmarkshavn",
"uuid": "eb352f24-3a72-47a9-96cc-7b508ef52d8e"
}
Creating
- POST /backupschedulers/
Creates a new backup scheduler.
- statuscode 201:
object created
Example request:
Example response
HTTP/1.1 201 CREATED
Content-Type: application/json; charset=utf-8
{
"objects": [
{
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"grantees": [],
"incremental_backup": {
"day_of_month": "*",
"day_of_week": ["*"],
"end_time": {
"hour": 11,
"minute": 45
},
"hour": "1",
"minute": "0",
"month": "*",
"repeat": {
"hour": "",
"minute": ""
},
"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": "Son, Father, GrandFather Policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"permissions": [],
"remote_location": "",
"resource_uri": "/api/2.0/backupschedulers/0377f6e9-e5f2-4a0a-bb4e-c28c8424eda1/",
"retention_policy": {
"name": "Son, Father, GrandFather Policy",
"rules": [
{
"period": "days",
"quantity": 7
},
{
"period": "weeks",
"quantity": 4,
"time_option": 1
},
{
"period": "months",
"quantity": 12,
"time_option": 23
}
]
},
"tags": [],
"type": "snapshot",
"user_timezone": "Etc/GMT+12",
"uuid": "0377f6e9-e5f2-4a0a-bb4e-c28c8424eda1"
}
]
}
Editing
- PUT /backupschedulers/{backupscheduler_uuid}/
Edits a backup scheduler identified by backupscheduler_uuid.
- statuscode 200:
no errors
Example request:
PUT /api/2.0/backupschedulers/1c232887-aa47-45a8-96e6-3293f3b220cb/ HTTP/1.1
Content-Type: application/json
Authorization: Basic SWYgeW91IGZvdW5kIHRoaXMsIGhhdmUgYSBjb29raWUsIHlvdSBkZXNlcnZlIGl0IDop
{
"type": "snapshot",
"name": "Son, Father, GrandFather Policy",
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"is_enabled": true,
"is_default": false,
"manual_incremental_backup": "",
"retention_policy": {
"name": "Son, Father, GrandFather Policy",
"rules": [
{ "period": "days", "quantity": 7 },
{ "period": "weeks", "quantity": 4, "time_option": 1 },
{ "period": "months", "quantity": 12, "time_option": 23 }
]
},
"initial_backup": {
"day_of_week": ["*"],
"start_time": { "hour": 12, "minute": 0 },
"end_time": { "hour": 11, "minute": 45 }
},
"incremental_backup": {
"day_of_month": "*",
"day_of_week": ["*"],
"month": "*",
"hour": "1",
"minute": "0",
"repeat": { "hour": "", "minute": "" },
"start_time": { "hour": 12, "minute": 0 },
"end_time": { "hour": 11, "minute": 45 }
},
"user_timezone": "Etc/GMT+12"
}
Example response:
{
"enable_backup_policy_notifications": true,
"enable_retention_policy_notifications": false,
"grantees": [],
"incremental_backup": {
"day_of_month": "*",
"day_of_week": ["*"],
"end_time": {
"hour": 11,
"minute": 45
},
"hour": "1",
"minute": "0",
"month": "*",
"repeat": {
"hour": "",
"minute": ""
},
"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": "Son, Father, GrandFather Policy",
"orchestrator_timezone": "",
"owner": {
"resource_uri": "/api/2.0/user/6a02f732-4dae-47d6-ac18-f4ddb6fc4b31/",
"uuid": "6a02f732-4dae-47d6-ac18-f4ddb6fc4b31"
},
"permissions": [],
"remote_location": "",
"resource_uri": "/api/2.0/backupschedulers/ead05317-e67f-4603-9afe-4cb6aab52e52/",
"retention_policy": {
"name": "Son, Father, GrandFather Policy",
"rules": [
{
"period": "days",
"quantity": 7
},
{
"period": "weeks",
"quantity": 4
},
{
"time_option": 1
},
{
"period": "months",
"quantity": 12
},
{
"time_option": 23
}
]
},
"tags": [],
"type": "snapshot",
"user_timezone": "Etc/GMT+12",
"uuid": "ead05317-e67f-4603-9afe-4cb6aab52e52"
}
Deleting
Single backup scheduler
- DELETE /backupschedulers/{uuid}/
Deletes a single backup scheduler.
- statuscode 204:
No content, object deletion started.
Example request:
DELETE /api/2.0/backupschedulers/09be1ca1-6a17-4686-95ad-fd36dfcf99f9/ HTTP/1.1
Content-Type: application/json
Authorization: Basic SWYgeW91IGZvdW5kIHRoaXMsIGhhdmUgYSBjb29raWUsIHlvdSBkZXNlcnZlIGl0IDop
Example response:
HTTP/1.1 204 NO CONTENT
Content-Type: text/html; charset=utf-8
Deletes multiple backup schedulers
- DELETE /backupschedulers/
Deletes multiple backup schedulers specified by their UUID’s.
- 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.
- statuscode 202:
Action accepted, execution is proceeding
Example request:
POST /api/2.0/drives/34f9c721-ec23-4f5c-86ab-2839f687f14e/action/?do=set_scheduler HTTP/1.1
Content-Type: application/json
Authorization: Basic SWYgeW91IGZvdW5kIHRoaXMsIGhhdmUgYSBjb29raWUsIHlvdSBkZXNlcnZlIGl0IDop
{
"backup_policy_uuid": "103de42c-17a1-40ea-bc0f-521789168bbf"
}
Example response
HTTP/1.1 202 ACCEPTED
Content-Type: application/json; charset=utf-8
{
"affinities": [],
"allow_multimount": false,
"backup_scheduler": {
"resource_uri": "/api/2.0/backupschedulers/103de42c-17a1-40ea-bc0f-521789168bbf/",
"uuid": "103de42c-17a1-40ea-bc0f-521789168bbf"
},
"grantees": [],
"iops": null,
"jobs": [],
"licenses": [],
"media": "disk",
"meta": {},
"mounted_on": [],
"name": "test_drive_remote_snapshot_1",
"owner": {
"resource_uri": "/api/2.0/user/18f6256b-90a2-4908-b671-c28c6b79c020/",
"uuid": "18f6256b-90a2-4908-b671-c28c6b79c020"
},
"permissions": [],
"remote_snapshots": [],
"resource_uri": "/api/2.0/drives/34f9c721-ec23-4f5c-86ab-2839f687f14e/",
"runtime": {
"is_snapshotable": true,
"snapshots_allocated_size": 0,
"storage_type": "dssd"
},
"size": 1073741824,
"snapshots": [],
"status": "unmounted",
"storage_type": "dssd",
"tags": [
{
"resource_uri": "/api/2.0/tags/6310b9fb-a411-49cc-9381-15f51022b26a/",
"uuid": "6310b9fb-a411-49cc-9381-15f51022b26a"
}
],
"uuid": "34f9c721-ec23-4f5c-86ab-2839f687f14e"
}
Allowed timezones
The following list are the allowed timezone values for the field user_timezone.
[
"Etc/GMT+12",
"Etc/GMT+11",
"Pacific/Midway",
"Pacific/Niue",
"Pacific/Pago_Pago",
"Etc/GMT+10",
"Pacific/Honolulu",
"Pacific/Johnston",
"Pacific/Rarotonga",
"Pacific/Tahiti",
"America/Anchorage",
"America/Juneau",
"America/Nome",
"America/Sitka",
"America/Yakutat",
"America/Santa_Isabel",
"America/Dawson",
"America/Los_Angeles",
"America/Tijuana",
"America/Vancouver",
"America/Whitehorse",
"PST8PDT",
"America/Creston",
"America/Dawson_Creek",
"America/Hermosillo",
"America/Phoenix",
"Etc/GMT+7",
"America/Chihuahua",
"America/Mazatlan",
"America/Boise",
"America/Cambridge_Bay",
"America/Denver",
"America/Edmonton",
"America/Inuvik",
"America/Ojinaga",
"America/Yellowknife",
"MST7MDT",
"America/Belize",
"America/Costa_Rica",
"America/El_Salvador",
"America/Guatemala",
"America/Managua",
"America/Tegucigalpa",
"Etc/GMT+6",
"Pacific/Galapagos",
"America/Chicago",
"America/Indiana/Knox",
"America/Indiana/Tell_City",
"America/Matamoros",
"America/Menominee",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Resolute",
"America/Winnipeg",
"CST6CDT",
"America/Bahia_Banderas",
"America/Cancun",
"America/Merida",
"America/Mexico_City",
"America/Monterrey",
"America/Regina",
"America/Swift_Current",
"America/Bogota",
"America/Cayman",
"America/Coral_Harbour",
"America/Eirunepe",
"America/Guayaquil",
"America/Jamaica",
"America/Lima",
"America/Panama",
"America/Rio_Branco",
"Etc/GMT+5",
"America/Detroit",
"America/Havana",
"America/Indiana/Petersburg",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Iqaluit",
"America/Kentucky/Monticello",
"America/Louisville",
"America/Montreal",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Pangnirtung",
"America/Port-au-Prince",
"America/Thunder_Bay",
"America/Toronto",
"EST5EDT",
"America/Indiana/Marengo",
"America/Indiana/Vevay",
"America/Indianapolis",
"America/Caracas",
"America/Asuncion",
"America/Glace_Bay",
"America/Goose_Bay",
"America/Halifax",
"America/Moncton",
"America/Thule",
"Atlantic/Bermuda",
"America/Campo_Grande",
"America/Cuiaba",
"America/Anguilla",
"America/Antigua",
"America/Aruba",
"America/Barbados",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Curacao",
"America/Dominica",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guyana",
"America/Kralendijk",
"America/La_Paz",
"America/Lower_Princes",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Montserrat",
"America/Port_of_Spain",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Santo_Domingo",
"America/St_Barthelemy",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Tortola",
"Etc/GMT+4",
"America/Santiago",
"Antarctica/Palmer",
"America/St_Johns",
"America/Sao_Paulo",
"America/Argentina/La_Rioja",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Buenos_Aires",
"America/Catamarca",
"America/Cordoba",
"America/Jujuy",
"America/Mendoza",
"America/Araguaina",
"America/Belem",
"America/Cayenne",
"America/Fortaleza",
"America/Maceio",
"America/Paramaribo",
"America/Recife",
"America/Santarem",
"Antarctica/Rothera",
"Atlantic/Stanley",
"Etc/GMT+3",
"America/Godthab",
"America/Montevideo",
"America/Bahia",
"America/Noronha",
"Atlantic/South_Georgia",
"Etc/GMT+2",
"America/Scoresbysund",
"Atlantic/Azores",
"Atlantic/Cape_Verde",
"Etc/GMT+1",
"Africa/Casablanca",
"Africa/El_Aaiun",
"America/Danmarkshavn",
"Etc/GMT",
"Atlantic/Canary",
"Atlantic/Faeroe",
"Atlantic/Madeira",
"Europe/Dublin",
"Europe/Guernsey",
"Europe/Isle_of_Man",
"Europe/Jersey",
"Europe/Lisbon",
"Europe/London",
"Africa/Abidjan",
"Africa/Accra",
"Africa/Bamako",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Freetown",
"Africa/Lome",
"Africa/Monrovia",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Sao_Tome",
"Atlantic/Reykjavik",
"Atlantic/St_Helena",
"Arctic/Longyearbyen",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Berlin",
"Europe/Busingen",
"Europe/Gibraltar",
"Europe/Luxembourg",
"Europe/Malta",
"Europe/Monaco",
"Europe/Oslo",
"Europe/Rome",
"Europe/San_Marino",
"Europe/Stockholm",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Zurich",
"Europe/Belgrade",
"Europe/Bratislava",
"Europe/Budapest",
"Europe/Ljubljana",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Tirane",
"Africa/Ceuta",
"Europe/Brussels",
"Europe/Copenhagen",
"Europe/Madrid",
"Europe/Paris",
"Europe/Sarajevo",
"Europe/Skopje",
"Europe/Warsaw",
"Europe/Zagreb",
"Africa/Algiers",
"Africa/Bangui",
"Africa/Brazzaville",
"Africa/Douala",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Luanda",
"Africa/Malabo",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Porto-Novo",
"Africa/Tunis",
"Etc/GMT-1",
"Africa/Windhoek",
"Asia/Nicosia",
"Europe/Athens",
"Europe/Bucharest",
"Europe/Chisinau",
"Asia/Beirut",
"Africa/Cairo",
"Asia/Damascus",
"Africa/Blantyre",
"Africa/Bujumbura",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Kigali",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Etc/GMT-2",
"Europe/Helsinki",
"Europe/Kiev",
"Europe/Mariehamn",
"Europe/Riga",
"Europe/Sofia",
"Europe/Tallinn",
"Europe/Uzhgorod",
"Europe/Vilnius",
"Europe/Zaporozhye",
"Europe/Istanbul",
"Asia/Jerusalem",
"Africa/Tripoli",
"Asia/Amman",
"Asia/Baghdad",
"Europe/Kaliningrad",
"Europe/Minsk",
"Asia/Aden",
"Asia/Bahrain",
"Asia/Kuwait",
"Asia/Qatar",
"Asia/Riyadh",
"Africa/Addis_Ababa",
"Africa/Asmera",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Mogadishu",
"Africa/Nairobi",
"Antarctica/Syowa",
"Etc/GMT-3",
"Indian/Antananarivo",
"Indian/Comoro",
"Indian/Mayotte",
"Asia/Tehran",
"Asia/Dubai",
"Asia/Muscat",
"Etc/GMT-4",
"Asia/Baku",
"Europe/Moscow",
"Europe/Samara",
"Europe/Simferopol",
"Europe/Volgograd",
"Indian/Mahe",
"Indian/Mauritius",
"Indian/Reunion",
"Asia/Tbilisi",
"Asia/Yerevan",
"Asia/Kabul",
"Antarctica/Mawson",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Dushanbe",
"Asia/Oral",
"Asia/Samarkand",
"Asia/Tashkent",
"Etc/GMT-5",
"Indian/Kerguelen",
"Indian/Maldives",
"Asia/Karachi",
"Asia/Kolkata",
"Asia/Colombo",
"Asia/Katmandu",
"Antarctica/Vostok",
"Asia/Almaty",
"Asia/Bishkek",
"Asia/Qyzylorda",
"Asia/Urumqi",
"Etc/GMT-6",
"Indian/Chagos",
"Asia/Dhaka",
"Asia/Thimphu",
"Asia/Yekaterinburg",
"Asia/Rangoon",
"Indian/Cocos",
"Antarctica/Davis",
"Asia/Bangkok",
"Asia/Hovd",
"Asia/Jakarta",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Saigon",
"Asia/Vientiane",
"Etc/GMT-7",
"Indian/Christmas",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Hong_Kong",
"Asia/Macau",
"Asia/Shanghai",
"Asia/Krasnoyarsk",
"Asia/Brunei",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Makassar",
"Asia/Manila",
"Asia/Singapore",
"Etc/GMT-8",
"Antarctica/Casey",
"Australia/Perth",
"Asia/Taipei",
"Asia/Choibalsan",
"Asia/Ulaanbaatar",
"Asia/Irkutsk",
"Asia/Dili",
"Asia/Jayapura",
"Asia/Tokyo",
"Etc/GMT-9",
"Pacific/Palau",
"Asia/Pyongyang",
"Asia/Seoul",
"Australia/Adelaide",
"Australia/Broken_Hill",
"Australia/Darwin",
"Australia/Brisbane",
"Australia/Lindeman",
"Australia/Melbourne",
"Australia/Sydney",
"Antarctica/DumontDUrville",
"Etc/GMT-10",
"Pacific/Guam",
"Pacific/Port_Moresby",
"Pacific/Saipan",
"Pacific/Truk",
"Australia/Currie",
"Australia/Hobart",
"Asia/Chita",
"Asia/Khandyga",
"Asia/Yakutsk",
"Antarctica/Macquarie",
"Etc/GMT-11",
"Pacific/Efate",
"Pacific/Guadalcanal",
"Pacific/Kosrae",
"Pacific/Noumea",
"Pacific/Ponape",
"Asia/Sakhalin",
"Asia/Ust-Nera",
"Asia/Vladivostok",
"Antarctica/McMurdo",
"Pacific/Auckland",
"Etc/GMT-12",
"Pacific/Funafuti",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Nauru",
"Pacific/Tarawa",
"Pacific/Wake",
"Pacific/Wallis",
"Pacific/Fiji",
"Asia/Anadyr",
"Asia/Kamchatka",
"Asia/Magadan",
"Asia/Srednekolymsk",
"Etc/GMT-13",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Tongatapu",
"Pacific/Apia"
]
Field reference
Examples of backup schedulers and retention policies
- Backup Scheduler: Every 45 Minutes
- Snapshot Policy: Every 12 Hours. Keep Last 2 Days
- Backup Scheduler: Every Sunday at 23:00
- Backup Scheduler: Every First of the Month at 23:59
- Backup Scheduler: Every Hour (20:00–23:00)
- Snapshot Policy: Defined Hours Backups (Keep 1 Month)
- Weekdays 3AM Snapshot Policy
- Weekdays Workhours Backup Policy
- Bi-monthly Backup Policy
- 1st of the Month Backup Policy
- Son, Father, Grandfather (SFG) Retention Strategy
Notifications
When using the backup schedulers, you can receive email notifications when certain actions occur—like when a remote snapshot is created or deleted by the scheduler.
Schema
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"allowed_detail_http_methods": [
"get",
"put",
"delete"
],
"allowed_list_http_methods": [
"get",
"post",
"delete"
],
"default_format": "application/json",
"default_limit": 20,
"fields": {
"enable_backup_policy_notifications": {
"default": true,
"help_text": "Enable notifications for actions triggered by the backup policy",
"readonly": false,
"required": false,
"type": "boolean"
},
"enable_retention_policy_notifications": {
"default": true,
"help_text": "Enable notifications for actions triggered by the retention policy",
"readonly": false,
"required": false,
"type": "boolean"
},
"grantees": {
"default": "No default provided.",
"help_text": "A list of data. Ex: ['abc', 26.73, 8]",
"readonly": false,
"required": false,
"type": "list"
},
"incremental_backup": {
"default": "No default provided.",
"fields": {
"day_of_month": {
"blank": false,
"default": "No default provided.",
"help_text": "Set day of the month rule to the scheduler.Accepts values between 1 and 31.",
"nullable": false,
"readonly": false,
"type": "string",
"unique": false
},
"day_of_week": {
"blank": false,
"default": "No default provided.",
"help_text": "Set day of the week rule to the scheduler.Accepts values mon, tue, wed, thu, fri, sat, sun.",
"nullable": false,
"readonly": false,
"type": "string",
"unique": false
},
"end_time": {
"blank": false,
"default": "No default provided.",
"help_text": "Set the end time hour.rule",
"nullable": false,
"readonly": false,
"type": "string",
"unique": false
},
"hour": {
"blank": false,
"default": "No default provided.",
"help_text": "Set hour rule to the scheduler.Accepts values between 0 and 23.",
"nullable": false,
"readonly": false,
"type": "string",
"unique": false
},
"minute": {
"blank": false,
"default": "No default provided.",
"help_text": "Set minute rule to the scheduler.Accepts values between 0 and 59.",
"nullable": false,
"readonly": false,
"type": "string",
"unique": false
},
"month": {
"blank": false,
"default": "No default provided.",
"help_text": "Set month rule to the scheduler.Accepts values between 1 and 12, 1=January, 12=December",
"nullable": false,
"readonly": false,
"type": "string",
"unique": false
},
"repeat": {
"blank": true,
"default": "No default provided.",
"help_text": "Repeat fields",
"nullable": true,
"readonly": false,
"type": "related",
"unique": false
},
"start_time": {
"blank": false,
"default": "No default provided.",
"help_text": "Set the start time hour.rule",
"nullable": false,
"readonly": false,
"type": "string",
"unique": false
}
},
"help_text": "Incremental backup policies of the backup scheduler",
"readonly": false,
"required": true,
"type": "related"
},
"initial_backup": {
"default": "No default provided.",
"fields": {
"day_of_week": {
"blank": false,
"default": "No default provided.",
"help_text": "Set day of the week rule to the scheduler.Accepts values mon, tue, wed, thu, fri, sat, sun.",
"nullable": false,
"readonly": false,
"type": "string",
"unique": false
},
"end_time": {
"blank": false,
"default": "No default provided.",
"help_text": "Set the end time hour.rule",
"nullable": false,
"readonly": false,
"type": "string",
"unique": false
},
"start_time": {
"blank": false,
"default": "No default provided.",
"help_text": "Set the start time hour.rule",
"nullable": false,
"readonly": false,
"type": "string",
"unique": false
}
},
"help_text": "Initial backup policies of the backup scheduler",
"readonly": false,
"required": false,
"type": "related"
},
"is_default": {
"default": null,
"help_text": "Set as default the backup scheduler",
"readonly": false,
"required": true,
"type": "boolean"
},
"is_enabled": {
"default": null,
"help_text": "Enabled or disabled the backup scheduler",
"readonly": false,
"required": true,
"type": "boolean"
},
"manual_incremental_backup": {
"default": null,
"help_text": "Set manual incremental time to create backups",
"readonly": false,
"required": true,
"type": "string"
},
"meta": {
"default": {
},
"help_text": "User assigned meta information for this policy",
"readonly": false,
"required": false,
"type": "dict"
},
"name": {
"default": null,
"help_text": "Optional human readable name of the backup scheduler",
"readonly": false,
"required": true,
"type": "string"
},
"orchestrator_timezone": {
"default": null,
"help_text": "Unicode string data. Ex: \"Hello World\"",
"readonly": false,
"required": false,
"type": "string"
},
"owner": {
"default": null,
"help_text": "Owner of the backup scheduler",
"readonly": true,
"required": true,
"type": "related"
},
"permissions": {
"default": "No default provided.",
"help_text": "A list of data. Ex: ['abc', 26.73, 8]",
"readonly": false,
"required": false,
"type": "list"
},
"remote_location": {
"default": null,
"help_text": "Remote location code",
"readonly": false,
"required": false,
"type": "string"
},
"resource_uri": {
"default": "No default provided.",
"help_text": "Unicode string data. Ex: \"Hello World\"",
"readonly": true,
"required": true,
"type": "string"
},
"retention_policy": {
"default": "No default provided.",
"fields": {
"name": {
"blank": false,
"default": "No default provided.",
"help_text": "Optional human readable name of the retention poicy",
"nullable": false,
"readonly": false,
"type": "string",
"unique": false
},
"rules": {
"blank": false,
"default": "No default provided.",
"help_text": "Retention policy rules",
"nullable": false,
"readonly": false,
"type": "list",
"unique": false
}
},
"help_text": "Retention policies of the backup scheduler",
"readonly": false,
"required": false,
"type": "related"
},
"tags": {
"default": "No default provided.",
"help_text": "Many related resources. Can be either a list of URIs or list of individually nested resource data.",
"readonly": false,
"required": false,
"type": "related"
},
"type": {
"choices": [
"migration",
"backup",
"dr",
"snapshot"
],
"default": null,
"help_text": "Policy type",
"readonly": false,
"required": true,
"type": "string"
},
"user_timezone": {
"default": null,
"help_text": "Unicode string data. Ex: \"Hello World\"",
"readonly": false,
"required": false,
"type": "string"
},
"uuid": {
"default": null,
"help_text": "UUID of the backup scheduler",
"readonly": true,
"required": true,
"type": "string"
}
},
"filtering": {
"name": "exact",
"name__contains": "exact",
"tag": "exact",
"uuid": "exact"
},
"ordering": [
"uuid",
"name"
]
}