Get Backup Configuration

Get Backup Configuration

Retrieve the backup configuration for SDDC Manager and NSX Manager

Request
URI
GET
https://sfo-vcf01.rainpole.io//v1/system/backup-configuration
COPY
Responses
200

Ok

Returns BackupConfiguration of type(s) application/json
{
    "backupLocations": [
        {
            "directoryPath": "string",
            "password": "string",
            "port": 0,
            "protocol": "SFTP",
            "server": "string",
            "sshFingerprint": "string",
            "username": "string"
        }
    ],
    "backupSchedules": [
        {
            "daysOfWeek": [
                "string"
            ],
            "frequency": "One among: WEEKLY, HOURLY",
            "hourOfDay": 0,
            "minuteOfHour": 0,
            "resourceType": "SDDC_MANAGER",
            "retentionPolicy": {
                "numberOfDaysOfDailyBackups": "20",
                "numberOfDaysOfHourlyBackups": "10",
                "numberOfMostRecentBackups": "15"
            },
            "takeBackupOnStateChange": "True",
            "takeScheduledBackups": "True"
        }
    ],
    "encryption": {
        "passphrase": "string"
    },
    "isConfigured": false
}
backupLocations
Optional

List of backup locations

backupSchedules
Optional

List of backup schedules

encryption
Optional

encryption

boolean
isConfigured
Optional

Backup configuration status of both FTP server and passphrase


400

Bad Request

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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.

string
remediationMessage
Optional

The localized remediation error message


500

Internal server error

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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.

string
remediationMessage
Optional

The localized remediation error message