Net3 API Interface for Customer Portal

VMBackups

The following routes are available for this service:
POST	/backups/VM/{sessionId}/{orgUserName}/{isRemote}
POST	/backups/VM

**VMBackups** Parameters:
Name	Parameter	Data Type	Required	Description
orgUserName	path	string	No
isRemote	path	bool	No

**BackupsBase** Parameters:
Name	Parameter	Data Type	Required
sessionId	form	string	No
datacenterLocation	form	string	No
orgName	form	string	No

**VMBackupsResponse** Parameters:
Name	Parameter	Data Type	Required
Hostname	form	string	No
Result	form	TypeHosts	No
ResponseStatus	form	ResponseStatus	No

**TypeHosts** Parameters:
Name	Parameter	Data Type	Required	Description
result	form	List<TypeHost>	No
status	form	int	No

**ResponseBase** Parameters:
Name	Parameter	Data Type	Required
Content	form	string	No
errorMessage	form	string	No
errorCode	form	int	No
errorStatus	form	bool	No

**TypeHost** Parameters:
Name	Parameter	Data Type	Required
friendlypath	form	string	No
svcname	form	string	No
installeddate	form	DateTime	No
ostype	form	string	No
ipaddress	form	string	No
uniquename	form	string	No
osversion	form	string	No
alternateip	form	string	No
id	form	string	No
originalhostid	form	string	No
timezone	form	string	No
description	form	string	No
isclusterhost	form	bool	No
vcenterhostid	form	string	No
modifydate	form	DateTime	No
isvm	form	bool	No
isesxhost	form	bool	No
hostname	form	string	No
vmtype	form	string	No
osrelease	form	string	No
hasagent	form	bool	No
isvcenterhost	form	bool	No
sourcecluster	form	string	No
targetcluster	form	string	No
connectorversion	form	string	No
hosttype	form	string	No
uploadversion	form	string	No
updatedate	form	DateTime	No
statusCode	form	string	No
hostApp	form	TypeApplication	No
hostBackups	form	TypeBackups	No
hostSLA	form	TypeSLA	No

**TypeApplication** Parameters:
Name	Parameter	Data Type	Required
id	form	long	No
auxinfo	form	string	No
protectable	form	string	No
appversion	form	string	No
morecredentials	form	string	No
volumes	form	string	No
username	form	string	No
hostid	form	long	No
lastfailover	form	DateTime	No
description	form	string	No
appname	form	string	No
sourcecluster	form	long	No
originalappid	form	long	No
apptype	form	string	No
failoverstate	form	string	No
friendlytype	form	string	No
ignore	form	bool	No
networkname	form	string	No
networkip	form	string	No
pathname	form	string	No
isclustered	form	bool	No

**TypeBackups** Parameters:
Name	Parameter	Data Type	Required	Description
result	form	List<TypeBackup>	No

**TypeBackup** Parameters:
Name	Parameter	Data Type	Required
virtualsize	form	double	No
originalbackupid	form	long	No
modifydate	form	DateTime	No
jobclass	form	string	No
flags	form	long	No
sourceuds	form	double	No
status	form	string	No
expiration	form	DateTime	No
hostname	form	string	No
appid	form	long	No
label	form	string	No
policyname	form	string	No
consistencydate	form	DateTime	No
id	form	long	No
backupdate	form	DateTime	No
mountedhost	form	long	No
username	form	string	No
backupname	form	string	No
sltname	form	string	No
sourceimage	form	string	No
prepdate	form	DateTime	No
slpname	form	string	No
appname	form	string	No
apptype	form	string	No
datastore	form	string	No
vmpath	form	string	No
sla	form	TypeSLA	No
systemstateOSType	form	string	No
systemstateNIC	form	string	No
logtruncated	form	string	No
restorelock	form	string	No
volumelabel	form	string	No
nasstaging	form	string	No
preserved	form	string	No
dnsname	form	string	No
nvolumes	form	string	No
sourcecluster	form	string	No
volumekey	form	string	No
originatingcluster	form	string	No
systemstateCPU	form	string	No
mappedhost	form	string	No
catalogstate	form	string	No
uniquehostname	form	string	No
restorableobject	form	string	No
backuplock	form	string	No
filename	form	string	No
isbootvolume	form	string	No
backuphost	form	string	No
sensitivity	form	string	No
consistencymode	form	string	No
modifiedbytes	form	string	No
originatinguds	form	string	No
hostconsistencydate	form	string	No
systemstateMemory	form	string	No
expirytries	form	string	No
vmname	form	string	No
characteristic	form	string	No
capacity	form	string	No
policyid	form	string	No
poolid	form	string	No
targetcluster	form	string	No
uniqueid	form	string	No
systemstateBootDiskSize	form	string	No
transport	form	string	No
esxhost	form	string	No
target	form	string	No
targetuds	form	string	No
depth	form	string	No
componenttype	form	string	No
readyvm	form	string	No
isbootvmdk	form	string	No
logicalname	form	string	No
originalappid	form	string	No

**BackupResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	TypeBackup	No
ResponseStatus	form	ResponseStatus	No

**TypeSLA** Parameters:
Name	Parameter	Data Type	Required
id	form	int	No
modifydate	form	DateTime	No
expirationoff	form	bool	No
slpid	form	int	No
description	form	string	No
createdate	form	DateTime	No
dedupasyncoff	form	bool	No
appid	form	int	No
scheduleoff	form	bool	No
sltid	form	int	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /backups/VM/{sessionId}/{orgUserName}/{isRemote} HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	orgUserName: String,
	isRemote: False,
	sessionId: String,
	datacenterLocation: String,
	orgName: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	hostname: String,
	result: 
	{
		result: 
		[
			{
				friendlypath: String,
				svcname: String,
				installeddate: 0001-01-01,
				ostype: String,
				ipaddress: String,
				uniquename: String,
				osversion: String,
				alternateip: String,
				id: String,
				originalhostid: String,
				timezone: String,
				description: String,
				isclusterhost: False,
				vcenterhostid: String,
				modifydate: 0001-01-01,
				isvm: False,
				isesxhost: False,
				hostname: String,
				vmtype: String,
				osrelease: String,
				hasagent: False,
				isvcenterhost: False,
				sourcecluster: String,
				targetcluster: String,
				connectorversion: String,
				hosttype: String,
				uploadversion: String,
				updatedate: 0001-01-01,
				statusCode: String,
				hostApp: 
				{
					id: 0,
					auxinfo: String,
					protectable: String,
					appversion: String,
					morecredentials: String,
					volumes: String,
					username: String,
					hostid: 0,
					lastfailover: 0001-01-01,
					description: String,
					appname: String,
					sourcecluster: 0,
					originalappid: 0,
					apptype: String,
					failoverstate: String,
					friendlytype: String,
					ignore: False,
					networkname: String,
					networkip: String,
					pathname: String,
					isclustered: False,
					content: String,
					errorMessage: String,
					errorCode: 0,
					errorStatus: False
				},
				hostBackups: 
				{
					result: 
					[
						{
							virtualsize: 0,
							originalbackupid: 0,
							modifydate: 0001-01-01,
							jobclass: String,
							flags: 0,
							sourceuds: 0,
							status: String,
							expiration: 0001-01-01,
							hostname: String,
							appid: 0,
							label: String,
							policyname: String,
							consistencydate: 0001-01-01,
							id: 0,
							backupdate: 0001-01-01,
							mountedhost: 0,
							username: String,
							backupname: String,
							sltname: String,
							sourceimage: String,
							prepdate: 0001-01-01,
							slpname: String,
							appname: String,
							apptype: String,
							datastore: String,
							vmpath: String,
							sla: 
							{
								id: 0,
								modifydate: 0001-01-01,
								expirationoff: False,
								slpid: 0,
								description: String,
								createdate: 0001-01-01,
								dedupasyncoff: False,
								appid: 0,
								scheduleoff: False,
								sltid: 0
							},
							systemstateOSType: String,
							systemstateNIC: String,
							logtruncated: String,
							restorelock: String,
							volumelabel: String,
							nasstaging: String,
							preserved: String,
							dnsname: String,
							nvolumes: String,
							sourcecluster: String,
							volumekey: String,
							originatingcluster: String,
							systemstateCPU: String,
							mappedhost: String,
							catalogstate: String,
							uniquehostname: String,
							restorableobject: String,
							backuplock: String,
							filename: String,
							isbootvolume: String,
							backuphost: String,
							sensitivity: String,
							consistencymode: String,
							modifiedbytes: String,
							originatinguds: String,
							hostconsistencydate: String,
							systemstateMemory: String,
							expirytries: String,
							vmname: String,
							characteristic: String,
							capacity: String,
							policyid: String,
							poolid: String,
							targetcluster: String,
							uniqueid: String,
							systemstateBootDiskSize: String,
							transport: String,
							esxhost: String,
							target: String,
							targetuds: String,
							depth: String,
							componenttype: String,
							readyvm: String,
							isbootvmdk: String,
							logicalname: String,
							originalappid: String,
							jobid: String,
							statusCode: String,
							content: String,
							errorMessage: String,
							errorCode: 0,
							errorStatus: False
						}
					]
				},
				hostSLA: 
				{
					id: 0,
					modifydate: 0001-01-01,
					expirationoff: False,
					slpid: 0,
					description: String,
					createdate: 0001-01-01,
					dedupasyncoff: False,
					appid: 0,
					scheduleoff: False,
					sltid: 0
				},
				content: String,
				errorMessage: String,
				errorCode: 0,
				errorStatus: False
			}
		],
		status: 0,
		content: String,
		errorMessage: String,
		errorCode: 0,
		errorStatus: False
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}