[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
Get Backup Configuration
DescriptionRetrieve the backup configuration for SDDC Manager and NSX Manager
Request
Operation doesn't accept any path, query or header parameters.
URL
https://sfo-vcf01.rainpole.io/v1/system/backup-configuration
Response
Response
Response BodyResponse Body
200 OK
Returns
BackupConfiguration
of type(s) application/json
{
"backupLocations": [
{
"directoryPath": "string",
"password": "string",
"port": 0,
"protocol": "SFTP",
"server": "string",
"sshFingerprint": "string",
"username": "string"
}
],
"backupSchedules": [
{
"daysOfWeek": [
"One among: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY"
],
"frequency": "One among: WEEKLY, HOURLY",
"hourOfDay": 0,
"minuteOfHour": 0,
"resourceType": "SDDC_MANAGER",
"retentionPolicy": {
"numberOfDaysOfDailyBackups": 0,
"numberOfDaysOfHourlyBackups": 0,
"numberOfMostRecentBackups": 0
},
"takeBackupOnStateChange": false,
"takeScheduledBackups": false
}
],
"encryption": {
"passphrase": "string"
},
"isConfigured": false
}
boolean
isConfigured
Optional
Backup configuration status of both FTP server and passphrase
Errors
Error
400
Bad Request
Error
500
Internal server error
Code Samples
cURL Command
curl https://sfo-vcf01.rainpole.io/v1/system/backup-configuration
[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
On This Page
Backup Restore Operations
get
post
post
