[{"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

Backup Tasks

Description

Trigger backup

Request

URL

post

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

Copy

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

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

Error

400

Bad Request

Error

500

Internal server error

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

vcf-for-vxrail

Backup Restore Operations

post

Backup Tasks

put

Configure Backup Settings

patch

Edit Backup Settings

get

Get Backup Settings

post

Restores Tasks

get

Restores Tasks

Backup Tasks

Request

URL

Request Body

Response

Response Body

200 OK

Response Body

202 Accepted

Errors

Code Samples

cURL Command

On This Page

Backup Restore Operations

Was this page helpful?