Set Backup Configuration

Set Backup Configuration

Configure the backup configuration for SDDC Manager and NSX Manager

Request
URI
PUT
https://{api_host}/v1/system/backup-configuration
COPY
Request Body
BackupConfigurationSpec of type(s) application/json
Required 
{
    "encryption": {
        "passphrase": "string"
    },
    "backupLocations": [
        {
            "server": "string",
            "port": 0,
            "protocol": "SFTP",
            "username": "string",
            "password": "string",
            "directoryPath": "string",
            "sshFingerprint": "string"
        }
    ],
    "backupSchedules": [
        {
            "resourceType": "SDDC_MANAGER",
            "takeScheduledBackups": true,
            "frequency": "One among: WEEKLY, HOURLY",
            "daysOfWeek": [
                "One among: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY"
            ],
            "hourOfDay": 0,
            "minuteOfHour": 0,
            "takeBackupOnStateChange": true,
            "retentionPolicy": {
                "numberOfMostRecentBackups": 15,
                "numberOfDaysOfHourlyBackups": 10,
                "numberOfDaysOfDailyBackups": 20
            }
        }
    ]
}
object
encryption
Optional

Restore Specification

array of object
backupLocations
Optional

List of backup locations

array of object
backupSchedules
Optional

List of backup schedules

Responses
200

Ok

Returns Validation of type(s) application/json 
"Validation Object"
string
id
Required

ID of the validation

string
description
Required

Description of the validation

string
executionStatus
Required

Execution status of the validation. One among: IN_PROGRESS, FAILED, COMPLETED, UNKNOWN, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS

string
resultStatus
Required

Result status of the validation after it has completed its execution. One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, UNKNOWN, CANCELLATION_IN_PROGRESS

array of object
validationChecks
Optional

List of one or more validation checks that are performed as part of the validation

object
additionalProperties
Optional

additionalProperties


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 PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/v1/system/backup-configuration
On This Page
Backup Restore Operations
GET
Get Backup Configuration
PUT
Set Backup Configuration
PATCH
Update Backup Configuration
POST
Validate Backup Configurations Operations
POST
Start Restore
POST
Start Backup
GET
Get Backup Location
GET
Get Restore Task