[{"label":"Latest (4.4.0)","version":"latest"},{"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

Edit Backup Settings

Description

Edit backup configuration to backup NSX and SDDC manager

Request

Request

URL

URL


patch
https://sfo-vcf01.rainpole.io/v1/system/backup-configuration
Copy

Request Body

Request Body

BackupConfigurationSpec of type(s) application/json Required

backupConfigurationSpec

{
	"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": "True",
			"takeScheduledBackups": "True"
		}
	],
	"encryption": {
		"passphrase": "string"
	}
}
array of BackupLocation
backupLocations Optional

List of backup locations


array of BackupSchedule
backupSchedules Optional

List of backup schedules


encryption Optional

Encryption passphrase to encrypt and decrypt backup file

Response

Response

Response Body

Response Body

202 Accepted returns Task of type(s) application/json
{
	"completionTimestamp": "string",
	"creationTimestamp": "string",
	"errors": [
		{
			"arguments": [
				"string"
			],
			"causes": [
				{
					"message": "string",
					"type": "string"
				}
			],
			"context": {
				"key": "string"
			},
			"errorCode": "string",
			"errorType": "string",
			"message": "string",
			"nestedErrors": "Error Object",
			"referenceToken": "string",
			"remediationMessage": "string"
		}
	],
	"id": "string",
	"isCancellable": false,
	"name": "string",
	"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
	"resources": [
		{
			"fqdn": "string",
			"name": "string",
			"resourceId": "string",
			"sans": [
				"string"
			],
			"type": "string"
		}
	],
	"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
	"subTasks": [
		{
			"completionTimestamp": "string",
			"creationTimestamp": "string",
			"description": "string",
			"errors": [
				{
					"arguments": [
						"string"
					],
					"causes": [
						{
							"message": "string",
							"type": "string"
						}
					],
					"context": {
						"key": "string"
					},
					"errorCode": "string",
					"errorType": "string",
					"message": "string",
					"nestedErrors": "Error Object",
					"referenceToken": "string",
					"remediationMessage": "string"
				}
			],
			"name": "string",
			"resources": [
				{
					"fqdn": "string",
					"name": "string",
					"resourceId": "string",
					"sans": [
						"string"
					],
					"type": "string"
				}
			],
			"stages": [
				{
					"completionTimestamp": "string",
					"creationTimestamp": "string",
					"description": "string",
					"errors": [
						{
							"arguments": [
								"string"
							],
							"causes": [
								{
									"message": "string",
									"type": "string"
								}
							],
							"context": {
								"key": "string"
							},
							"errorCode": "string",
							"errorType": "string",
							"message": "string",
							"nestedErrors": "Error Object",
							"referenceToken": "string",
							"remediationMessage": "string"
						}
					],
					"name": "string",
					"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
					"type": "string"
				}
			],
			"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
			"subTasks": "SubTask Object",
			"type": "string"
		}
	],
	"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
string
completionTimestamp Optional

Task completion timestamp


string
creationTimestamp Optional

Task creation timestamp


array of Error
errors Optional

List of errors in case of a failure


string
id Optional

Task ID


boolean
isCancellable Optional

Represents task can be cancellable or not.


string
name Optional

Task name


string
resolutionStatus Optional

Resolution state


array of Resource
resources Optional

List of resources associated with task


string
status Optional

Task status


array of SubTask
subTasks Optional

List of sub-tasks of the task


string
type Optional

Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is _

Errors

Errors

400

Bad Request


500

Internal server error

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"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":"True","takeScheduledBackups":"True"}],"encryption":{"passphrase":"string"}}' https://sfo-vcf01.rainpole.io/v1/system/backup-configuration


[{"label":"Latest (4.4.0)","version":"latest"},{"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
Feedback

Was this page helpful?