The API allows you to list, view, edit and create schedules.
Returns list of schedules filtered by specified query parameters.
name | type | description | constraints | multivalued |
---|---|---|---|---|
direction | query | no | ||
filter | query | no | ||
nameLike | query | no | ||
orderBy | query | no | ||
page | query | no | ||
project-uuid | query | no | ||
protected-entity | query | no | ||
rules | query | yes | ||
size | query | no | ||
type | query | "APP_BACKUP" or "CLOUD_BACKUP" or "OS_BACKUP" or "STORAGE_BACKUP" or "STORAGE_SNAPSHOT" or "VM_BACKUP" or "VM_RESTORE" or "VM_SNAPSHOT" | no |
media type | data type | description |
---|---|---|
application/json | array of ScheduleListRecord (JSON) | list of schedules filtered by specified query parameters |
GET /schedules
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"name" : "...",
"hour" : 12345,
"startWindowLength" : 12345,
"active" : true,
"months" : [ "JULY", "JANUARY" ],
"dayOfWeekOccurrences" : [ "THIRD_IN_MONTH", "LAST_IN_MONTH" ],
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"type" : "CLOUD_BACKUP",
"executionType" : "TIME",
"interval" : {
"startHour" : 12345,
"endHour" : 12345,
"frequency" : 12345
},
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"forceFullBackup" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"daysOfWeek" : [ {
"name" : "ENUM_NAME",
"description" : "Enum description"
}, {
"name" : "...",
"description" : "..."
} ],
"backupType" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"lastRun" : 1451649601000
} ]
Create a schedule.
name | type | description |
---|---|---|
project-uuid | query |
media type | data type | description |
---|---|---|
application/json | ScheduleRequest (JSON) | specify data for new schedule |
media type | data type | description |
---|---|---|
application/json | ScheduleDetails (JSON) | details of newly created schedule |
POST /schedules
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"hour" : 12345,
"startWindowLength" : 12345,
"active" : true,
"months" : [ "MAY", "JULY" ],
"dayOfWeekOccurrences" : [ "FIRST_IN_MONTH", "FIRST_IN_MONTH" ],
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"type" : "CLOUD_BACKUP",
"executionType" : "TIME",
"interval" : {
"startHour" : 12345,
"endHour" : 12345,
"frequency" : 12345
},
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"projectUuid" : "...",
"visibleForAllProjects" : true,
"forceFullBackup" : true,
"daysOfWeek" : [ {
"name" : "ENUM_NAME",
"description" : "Enum description"
}, {
"name" : "...",
"description" : "..."
} ],
"backupType" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"name" : "...",
"hour" : 12345,
"startWindowLength" : 12345,
"active" : true,
"backupType" : "FULL",
"daysOfWeek" : [ "FRIDAY", "WEDNESDAY" ],
"months" : [ "FEBRUARY", "FEBRUARY" ],
"dayOfWeekOccurrences" : [ "FIRST_IN_MONTH", "SECOND_IN_MONTH" ],
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"lastRun" : 12345,
"type" : "VM_SNAPSHOT",
"executionType" : "INTERVAL",
"interval" : {
"startHour" : 12345,
"endHour" : 12345,
"frequency" : 12345
},
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"forceFullBackup" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}
Remove schedule.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for schedule (use by vProtect) |
DELETE /schedules/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single schedule.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for schedule (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | ScheduleDetails (JSON) | a single schedule details |
GET /schedules/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"name" : "...",
"hour" : 12345,
"startWindowLength" : 12345,
"active" : true,
"backupType" : "INCREMENTAL",
"daysOfWeek" : [ "SATURDAY", "SUNDAY" ],
"months" : [ "OCTOBER", "OCTOBER" ],
"dayOfWeekOccurrences" : [ "SECOND_IN_MONTH", "FOURTH_IN_MONTH" ],
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"lastRun" : 12345,
"type" : "OS_BACKUP",
"executionType" : "INTERVAL",
"interval" : {
"startHour" : 12345,
"endHour" : 12345,
"frequency" : 12345
},
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"forceFullBackup" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}
Change schedule details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for schedule (use by vProtect) |
project-uuid | query |
media type | data type | description |
---|---|---|
application/json | ScheduleRequest (JSON) | specify schedule details to update |
media type | data type | description |
---|---|---|
application/json | ScheduleDetails (JSON) | updated details of schedule |
PUT /schedules/{guid}
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"hour" : 12345,
"startWindowLength" : 12345,
"active" : true,
"months" : [ "MAY", "JANUARY" ],
"dayOfWeekOccurrences" : [ "FIRST_IN_MONTH", "FOURTH_IN_MONTH" ],
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"type" : "STORAGE_BACKUP",
"executionType" : "TIME",
"interval" : {
"startHour" : 12345,
"endHour" : 12345,
"frequency" : 12345
},
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"projectUuid" : "...",
"visibleForAllProjects" : true,
"forceFullBackup" : true,
"daysOfWeek" : [ {
"name" : "ENUM_NAME",
"description" : "Enum description"
}, {
"name" : "...",
"description" : "..."
} ],
"backupType" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"name" : "...",
"hour" : 12345,
"startWindowLength" : 12345,
"active" : true,
"backupType" : "INCREMENTAL",
"daysOfWeek" : [ "WEDNESDAY", "TUESDAY" ],
"months" : [ "MARCH", "APRIL" ],
"dayOfWeekOccurrences" : [ "SECOND_IN_MONTH", "SECOND_IN_MONTH" ],
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"lastRun" : 12345,
"type" : "VM_RESTORE",
"executionType" : "TIME",
"interval" : {
"startHour" : 12345,
"endHour" : 12345,
"frequency" : 12345
},
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"forceFullBackup" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}