Validate Backup Configurations Operations

Validation API for backup configuration for SDDC Manager and NSX Manager

Request

URI

POST

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

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

202

Accepted

Returns Task of type(s) application/json

"Task Object"

string

Required

Task ID

string

name

Required

Task name

object

localizableDescriptionPack

Optional

A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.

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 _

string

status

Required

Task status

string

creationTimestamp

Required

Task creation timestamp

string

completionTimestamp

Optional

Task completion timestamp

array of object

subTasks

Optional

List of sub-tasks of the task

array of object

errors

Optional

List of errors in case of a failure

array of object

resources

Optional

List of resources associated with task

string

resolutionStatus

Optional

Resolution state

boolean

isCancellable

Optional

Represents task can be cancellable or not.

boolean

isRetryable

Optional

Indicates whether a task is eligible for retry or not.

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 '{}' https://{api_host}/v1/system/backup-configuration/validations

On This Page

Description

Request

Request Body

Response

202 Response Body

Errors

Backup Restore Operations

GET

Get Backup Configuration

PUT

Set Backup Configuration