This API has a deprecated equivalent from v7.0U1.
List Backup Schedules
Returns a list of existing schedules with details
Request
URLURL
https://{api_host}/api/appliance/recovery/backup/schedules
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
map of
RecoveryBackupSchedulesInfo
of type application/json
Map of schedule id to Info Structure The key in the result map will be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.
{
"enable": false,
"fast_backup": false,
"location": "string",
"location_user": "string",
"parts": [
"string"
],
"recurrence_info": {
"days": "MONDAY",
"hour": 0,
"minute": 0
},
"retention_info": {
"max_count": 0
}
}
boolean
enable
Required
Enable or disable a schedule, by default when created a schedule will be enabled.
string
location
Required
URL of the backup location.
array of
string
parts
Required
List of optional parts that will be included in backups based on this schedule details. Use the Parts.list operation to get information about the supported parts.
boolean
fast_backup
Optional
Option to enable Postgres DB/ VCDB fast backup If unset backup will proceed at slow rate
string
location_user
Optional
Username for the given location. If unset location user will not be used.
recurrence_info
Optional
Recurrence information for the schedule. If unset backup job is not scheduled. See Schedules.RecurrenceInfo
retention_info
Optional
Retention information for the schedule. If unset all the completed backup jobs are retained forever. See Schedules.RetentionInfo
Errors
500
com.vmware.vapi.std.errors.error : if any error occurs during the execution of the operation.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-ListRecoveryBackupSchedules
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/recovery/backup/schedules
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/appliance/recovery/backup/schedules
x-vmw-doc-operation: list
Availability
Added in 7.0U2
On This Page
Backup Schedules Operations
patch
delete
post
