[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf

Backup Tasks

Description

Trigger backup

Request

Request

URL

URL


post
https://sfo-vcf01.rainpole.io/v1/backups/tasks
Copy

Request Body

Request Body

BackupSpec of type(s) application/json Required

backupsSpec

{
	"elements": [
		{
			"resourceType": "SDDC_MANAGER"
		}
	]
}
array of BackupResource
elements Required

List of elements to be backed up

Response

Response

200 OK Response Body>

Response Body

200 OK

Returns BackupTask of type(s) application/json
{
    "status": "One among: IN_PROGRESS"
}
array of Error
errors Optional

List of errors in case of a failure


string
id Optional

Backup task ID


string
name Optional

Backup task name


array of Resource
resources Optional

Backup resources, to get the backup details


string
status Optional

Backup task status


202 Accepted Response Body>

Response Body

202 Accepted

Returns BackupTask of type(s) application/json
{
    "status": "One among: IN_PROGRESS"
}
array of Error
errors Optional

List of errors in case of a failure


string
id Optional

Backup task ID


string
name Optional

Backup task name


array of Resource
resources Optional

Backup resources, to get the backup details


string
status Optional

Backup task status

Errors

Errors

Error
400

Bad Request


Error
500

Internal server error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"elements":[{"resourceType":"SDDC_MANAGER"}]}' https://sfo-vcf01.rainpole.io/v1/backups/tasks


[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf
Feedback

Was this page helpful?