Start Backup

Start Backup

Start a backup operation

Request
URI
POST
https://{api_host}/v1/backups/tasks
COPY
Request Body
BackupSpec of type(s) application/json
Required
{
    "elements": [
        {
            "resourceType": "SDDC_MANAGER"
        }
    ]
}
array of object
elements
Required

List of elements to be backed up

Responses
202

Accepted

Returns BackupTask of type(s) application/json
"BackupTask Object"
string
id
Optional

Backup task ID

string
name
Optional

Backup task name

string
status
Optional

Backup task status

array of object
resources
Optional

Backup resources, to get the backup details

array of object
errors
Optional

List of errors in case of a failure


400

Bad Request

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

Internal server error

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"elements":["object"]}' https://{api_host}/v1/backups/tasks