Edit Backup Server

To edit a backup server, use the following request:

PUT /settings/backup_server/:id.xml
PUT /settings/backup_server/:id.json

XML Request Example

curl -i -X PUT -u account_email:API_key http://onapp.test/settings/backup_servers/2.xml -d '<backup_server><label>az_val_ue_xml</label><enabled>1</enabled><capacity>40</capacity><ip_address>172.0.0.2</ip_address><backup_ip_address>192.168.123.1</backup_ip_address><integrated_storage>1</integrated_storage></backup_server>' -H 'Accept: application/xml' -H 'Content-type: application/xml'

JSON Request Example

curl -i -X PUT -u account_email:API_key http://onapp.test/settings/backup_servers/2.json -d '{"backup_server":{"label":"az_val_ue_json", "enabled":"1", "capacity":"40", "ip_address":"172.0.0.1","backup_ip_address":"192.168.123.1","integrated_storage":"1"}}' -H 'Accept: application/json' -H 'Content-type: application/json' 

Where:

label – backup server label

enabled – set the enabled as 1 if you want the backup server to be enabled, or 0 if you want it to be disabled. If you skip the enabled parameter, the backup server will be disabled by default.

capacity* – set the backup server capacity

ip_address* – valid Ipv4 address

backup_server_ip_address - provisioning network IP address

You will get a 204 status response on success, and 404 if there is no such backup server with a requested ID or you entered an incorrect URL.

integrated_storageset to 1 to enable integrated storage on the backup server, or 0 if you want it to be disabled. If you skip this parameter, the integrated storage will be disabled by default.


Page History

v. 6.1 Edge 2

  • added the integrated_storage parameter