SolarWinds Backup Help

Adding backup devices in JSON-RPC API

To add a backup device, use the AddAccount method. Devices are added one at a time.

Required parameters

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

Optional parameters

Parameter Description Supported values
homeNodeInfo A group of parameters related to the storage node See second table below for child parameters

AccountInfo child parameters

Parameter Description Supported values
Name (required) A name to assign to the new device. It must not coincide with the names of existing devices. String
NameAlias An alternative name to assign to the new device. It must not coincide with this devices name or the names of existing devices. String
Password A password to assign to the new device. If no value is submitted, the password is generated automatically. String
PartnerId (required) The ID of the customer the device is created for (retrieved through the GetPartnerInfo method) Int
ProductId The 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
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

Optional HomeNodeInfo child parameters

Parameter Description Supported values
Id The ID number of the home storage node to assign to the device Int
LocationId The location of the storage node. We recommend using the location of the customer that owns the node. String
ActiveAccounts Number of active devices associated to this storage node String
TotalAccounts Total number of devices associated to this storage node String

Sample request

{
    "id": "jsonrpc",
    "visa": "33491-50121-1-1512736778-A99E8BAC8AC82XXXXX0000000XXXXXXXXXXXX00000",
    "method": "AddAccount",
    "jsonrpc": "2.0",
    "params": {
	"accountInfo": {
		"PartnerId": 33495,
		"Name": "test-device",
		"ProductId": 1,
		"StorageId": 1,
		"LocationId": 1
	}
    }
}

Sample response

{  
    "id":"jsonrpc",
    "jsonrpc":"2.0",
    "result":{  
	"result":{  
		"Id":72910,
		"Name":"test-device",
		"Password":"24e3ec5461ed",
		"Token":"068a53c1-a64b-45c8-a87e-0000XX0000X0Xx0"
	}
    },
    "visa":"33491-50121-1-1512736778-A99E8BAC8AC82XXXXX0000000XXXXXXXXXXXX00000"
}