Get Backup Location

Retrieve the backup location details

Request

URI

GET

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

COPY

Query Parameters

string

serverIP

Required

Backup server IP

string

port

Required

Backup server port

Responses

200

Returns BackupLocation of type(s) application/json

{
    "server": "string",
    "port": 0,
    "protocol": "SFTP",
    "username": "string",
    "password": "string",
    "directoryPath": "string",
    "sshFingerprint": "string"
}

string

server

Required

IP address or FQDN of the backup server

integer As int32 As int32

port

Required

Port number for the backup server to connect

string

protocol

Required

Protocol to be used for transferring files

string

username

Required

Backup server username

string

password

Optional

Backup server password

string

directoryPath

Required

Full directory path to save the backup files

string

sshFingerprint

Optional

SSH fingerprint of the backup server

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.