SolarWinds Backup Help

Changing device properties in JSON-RPC API

To modify a backup device, use the ModifyAccount method. You can change the following properties:

  • Re-assign the device to another customer
  • Change the amount of storage allocated to the device
  • Set an expiration time for the device
  • Change the location of the device
  • Re-assign the device to another storage pool

Device names and passwords cannot be changed.

Required parameters

Parameter Description Supported values
accountInfo A group of parameters related to the device See table below for child parameters

Optional parameters

Parameter Description Supported values
ForceRemoveCustomColumnValuesInOldScope Do you wish to force remove custom column values for the device
  • True
  • False

AccountInfo child parameters

Parameter Description Supported values
Id The Id of the device to modify String
Name The name of the device to modify String
NameAlias An alternative name to assign to the device. It must not coincide with this devices name or the names of existing devices. String
PartnerId (required) The ID of the customer to move the device to (retrieved through the GetPartnerInfo method) Int
ProductId The ID of the product to assign to the device. Use the EnumerateProducts method to get the list of products available to the customer. Int
LocationId The location of the device. We recommend using the location of the customer that owns the device (unless you know that the customer has storage in the desired location). Int
ExpirationTime The time code at which the device expires Int in Unix format. For example, 1535673599 stands for August 30, 2018.
ExpectedBackupSize The approximate amount of storage space required for the device. This information can help choose a suitable storage node for the device. Int (in mebibytes)
StorageLocationId The ID number of the storage location to be used for this new device Int
StorageId The ID of the storage pool the device will be assigned to Int
ProfileId The ID of the profile to assign to the device. Int

Sample request

Let's say you need to re-assign a device to another customer. To do it, submit the ID of the new customer together wit the device name.

{
	"id": "jsonrpc",
	"visa": "33491-50121-1-1512736778-A99E8BAC8AC82XXXXX0000000XXXXXXXXXXXX00000",
	"method": "ModifyAccount",
	"jsonrpc": "2.0",
	"params": {
		"accountInfo": {
			"PartnerId": 33493,
			"Name": "test-device",
			"NameAlias": "Test-Device-Alias"
		}
	}
}

Sample response

{
	"id": "jsonrpc",
	"jsonrpc": "2.0",
	"result": null,
	"visa": "33491-50121-1-1512736778-A99E8BAC8AC82XXXXX0000000XXXXXXXXXXXX00000"
}