Skip to content

put_replication_source

Alberto Gonzalez edited this page Oct 29, 2015 · 1 revision

(PUT)/replication/source

Description

Allows the user to modify the configuration of the replication source by system id on the target. For example, the target user may want to modify the customer, or location, or the storage on which this source's replicated backup data is kept.

Request

Syntax

PUT /api/replication/source/?sid={sid}
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>

Parameters

/?sid={sid} - source system ID to modify

Index Value Type Required
customer (1) customer name associated with source string optional
customer_id (1) customer ID long optional
location (1) location name associated with the source string optional
location_id (1) location ID long optional
storage_id storage used for this source's replicated backups long optional

Note: Items marked by (1) are not in Release 1.0, nor are the customers resource and APIs to manage them. A user may have a location ID, or they may have instead the customer and location by name which resolves to a location ID in the underlying implementation.

Response

200 success

Parameters

None.

Examples

Sample Request

PUT /api/replication/source/?sid={sid}
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>

data passed in:

{
    "storage_id": 3
}

Sample Response

HTTP Status: 200 (OK)

Failed source modification will return HTTP Status 500 with a result object with an error message and KB link as defined here

Clone this wiki locally