Changing device properties

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

ParameterDescriptionType/Supported values
accountInfoA group of parameters related to the deviceAccountInfo, (has child parameters of its own see the AccountInfo child parameters table below)

AccountInfo child parameters

ParameterDescriptionType/Supported values
IDAn ID to assign to the new device. It must not coincide with the ID of existing devices<int> Integer
NameA name to assign to the new device. It must not coincide with the names of existing devices.OptionalNonEmptyString String
NameAliasAn alternative name to assign to the new device. It must not coincide with this devices name or the names of existing devices.OptionalNonEmptyString String
PasswordA password to assign to the new device.OptionalNonEmptyString String
TokenA token that will become the Encryption Key/Security Code for the new deviceOptionalNonEmptyString String
TypeThe type of device, based on what data will be backed up<AccountType::Enum>
  • Undefined
  • BackupManager
  • Office365
  • GSuite
  • Count
PartnerIdThe ID of the customer the device is created for (retrieved through the GetPartnerInfo method)<int> Integer
ProductIdThe ID of the product to assign to the new device. Use the EnumerateProducts method to get the list of products available to the customer.<int> Integer
LocationIdThe 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). This can be found by running the EnumerateLocations method and finding the appropriate geographic region.<int> Integer
CreationTimeThe time code at which the device was created<std::time_t> Integer in Unix format. For example, 1535673599 stands for August 30, 2018
ExpirationTimeThe time code at which the device expires<std::time_t> Integer in Unix format. For example, 1535673599 stands for August 30, 2018
FlagsAn array of flags denoting the type of account<AccountFlags::FlagsType>
  • Undefined
  • Managed_Obsolete
  • Trial
  • Count
StorageLocationIdThe ID number of the storage location to be used for this new device<int> Integer
RemovalTimeThe time code at which the device will be removed<AbsoluteTime> Integer as the total number of seconds since the beginning of January 1st 1900
AccountGroupIdThe ID of the AccountGroup the device is associated to which can be found by running GetAccountGroup<int> Integer
OwnUserIdThe ID of the user running the call<int> Integer
StorageIdThe ID of the storage pool the device will be assigned to<int> Integer
ProfileIdThe ID of the profile to assign to the device.<int> Integer
ContinuityEnabledEnable or disable a continuity plan from an arrayContinuityState::Enum
  • Undefined
  • Disabled
  • RecoveryTesting
  • StandbyImage
  • Count

Optional parameters

ParameterDescriptionType/Supported values
forceRemoveCustomColumnValuesInOldScopeDo you wish to force remove custom column values for the devicebool Boolean
  • True
  • False

Sample request

In the below example, we are going to re-assign a device to another customer. To do so, submit the ID of the new customer together with the device name.

All other changes can be made by providing the new setting, information or value for the required parameter.

{
    "id": "jsonrpc",
    "visa": "{{visa}}",
    "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": "{{visa}}"
}

Did this page help you?