Get Backup Configuration

Retrieve the backup configuration for SDDC Manager and NSX Manager

Request

URI

GET

https://{api_host}/v1/system/backup-configuration

COPY

Responses

200

Returns BackupConfiguration of type(s) application/json

{
    "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
            }
        }
    ],
    "isConfigured": false
}

Encryption

encryption

Optional

Restore Specification

array of BackupLocation

backupLocations

Optional

List of backup locations

array of BackupSchedule

backupSchedules

Optional

List of backup schedules

boolean

isConfigured

Optional

Backup configuration status of both FTP server and passphrase

400

Bad Request

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

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 ErrorCause

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

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

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.