Update Backup Config

Update backup configuration

Saves remote backup server settings; include current _revision from GET when updating.

Request

URI

PUT

https://{api_host}/ssp/backup/config

COPY

Request Body

Backup configuration to update

BackupConfig of type(s) application/json

Required

This request body class requires all of the following: ManagedResource , InlineBackupConfig1

{
    "_create_user": "string",
    "_create_time": 0,
    "_last_modified_user": "string",
    "_last_modified_time": 0,
    "_revision": 0,
    "_resource_type": "string",
    "_system_owned": false,
    "id": "string",
    "display_name": "string",
    "description": "string",
    "site_ids": [
        "string"
    ],
    "server_address": "string",
    "protocol": "string",
    "port": 0,
    "username": "string",
    "ssh_public_key": "string",
    "backup_location": "string",
    "password": "string",
    "passphrase": "string"
}

Authentication

This operation uses the following authentication methods.

enterprise_admin

Responses

200

Successful response

Returns BackupConfig of type(s) application/json

This response body class contains all of the following: ManagedResource , InlineBackupConfig1

{
    "_create_user": "string",
    "_create_time": 0,
    "_last_modified_user": "string",
    "_last_modified_time": 0,
    "_revision": 0,
    "_resource_type": "string",
    "_system_owned": false,
    "id": "string",
    "display_name": "string",
    "description": "string",
    "site_ids": [
        "string"
    ],
    "server_address": "string",
    "protocol": "string",
    "port": 0,
    "username": "string",
    "ssh_public_key": "string",
    "backup_location": "string",
    "password": "string",
    "passphrase": "string"
}

400

Bad Request

Returns BadRequest of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

401

Unauthorized

Returns Unauthorized of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

403

Forbidden

Returns Forbidden of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

412

Precondition Failed

Returns PreconditionFailed of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

428

Precondition Required

Returns PreconditionRequired of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

429

Too Many Requests

Returns TooManyRequests of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

default

Unexpected error occurred

Returns Error of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"server_address":"string","protocol":"string","port":"integer","username":"string","backup_location":"string","ssh_public_key":"string","password":"string"}' https://{api_host}/ssp/backup/config

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Backup Restore Operations

GET

Get Backup Config

PUT