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

Restores Tasks

Description

Trigger Restore

Request

URL

post

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

Copy

Request Body

RestoreSpec of type(s) application/json Required

restoreSpec

{
	"backupFile": "string",
	"elements": [
		{
			"resourceType": "SDDC_MANAGER"
		}
	],
	"encryption": {
		"passphrase": "string"
	}
}

string

backupFile Required

Backup file name

array of BackupResource

elements Required

List of elements to be restored

Encryption

encryption Required

Encryption

Response

200 OK Response Body>

Response Body

200 OK

Returns Task of type(s) application/json

{
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
    "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 _

202 Accepted Response Body>

Response Body

202 Accepted

Returns Task of type(s) application/json

{
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
    "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

Error

400

Bad Request

Error

500

Internal server error

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"backupFile":"string","elements":[{"resourceType":"SDDC_MANAGER"}],"encryption":{"passphrase":"string"}}' https://sfo-vcf01.rainpole.io/v1/restores/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

Restores 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?