Net3 API Interface for Customer Portal

<back to all web services

VMBackups

Requires Authentication
The following routes are available for this service:
POST/backups/VM/{sessionId}/{orgUserName}/{isRemote}
POST/backups/VM
VMBackups Parameters:
NameParameterData TypeRequiredDescription
orgUserNamepathstringNo
isRemotepathboolNo
BackupsBase Parameters:
NameParameterData TypeRequiredDescription
sessionIdformstringNo
datacenterLocationformstringNo
orgNameformstringNo
VMBackupsResponse Parameters:
NameParameterData TypeRequiredDescription
HostnameformstringNo
ResultformTypeHostsNo
ResponseStatusformResponseStatusNo
TypeHosts Parameters:
NameParameterData TypeRequiredDescription
resultformList<TypeHost>No
statusformintNo
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
ContentformstringNo
errorMessageformstringNo
errorCodeformintNo
errorStatusformboolNo
TypeHost Parameters:
NameParameterData TypeRequiredDescription
friendlypathformstringNo
svcnameformstringNo
installeddateformDateTimeNo
ostypeformstringNo
ipaddressformstringNo
uniquenameformstringNo
osversionformstringNo
alternateipformstringNo
idformstringNo
originalhostidformstringNo
timezoneformstringNo
descriptionformstringNo
isclusterhostformboolNo
vcenterhostidformstringNo
modifydateformDateTimeNo
isvmformboolNo
isesxhostformboolNo
hostnameformstringNo
vmtypeformstringNo
osreleaseformstringNo
hasagentformboolNo
isvcenterhostformboolNo
sourceclusterformstringNo
targetclusterformstringNo
connectorversionformstringNo
hosttypeformstringNo
uploadversionformstringNo
updatedateformDateTimeNo
statusCodeformstringNo
hostAppformTypeApplicationNo
hostBackupsformTypeBackupsNo
hostSLAformTypeSLANo
TypeApplication Parameters:
NameParameterData TypeRequiredDescription
idformlongNo
auxinfoformstringNo
protectableformstringNo
appversionformstringNo
morecredentialsformstringNo
volumesformstringNo
usernameformstringNo
hostidformlongNo
lastfailoverformDateTimeNo
descriptionformstringNo
appnameformstringNo
sourceclusterformlongNo
originalappidformlongNo
apptypeformstringNo
failoverstateformstringNo
friendlytypeformstringNo
ignoreformboolNo
networknameformstringNo
networkipformstringNo
pathnameformstringNo
isclusteredformboolNo
TypeBackups Parameters:
NameParameterData TypeRequiredDescription
resultformList<TypeBackup>No
TypeBackup Parameters:
NameParameterData TypeRequiredDescription
virtualsizeformdoubleNo
originalbackupidformlongNo
modifydateformDateTimeNo
jobclassformstringNo
flagsformlongNo
sourceudsformdoubleNo
statusformstringNo
expirationformDateTimeNo
hostnameformstringNo
appidformlongNo
labelformstringNo
policynameformstringNo
consistencydateformDateTimeNo
idformlongNo
backupdateformDateTimeNo
mountedhostformlongNo
usernameformstringNo
backupnameformstringNo
sltnameformstringNo
sourceimageformstringNo
prepdateformDateTimeNo
slpnameformstringNo
appnameformstringNo
apptypeformstringNo
datastoreformstringNo
vmpathformstringNo
slaformTypeSLANo
systemstateOSTypeformstringNo
systemstateNICformstringNo
logtruncatedformstringNo
restorelockformstringNo
volumelabelformstringNo
nasstagingformstringNo
preservedformstringNo
dnsnameformstringNo
nvolumesformstringNo
sourceclusterformstringNo
volumekeyformstringNo
originatingclusterformstringNo
systemstateCPUformstringNo
mappedhostformstringNo
catalogstateformstringNo
uniquehostnameformstringNo
restorableobjectformstringNo
backuplockformstringNo
filenameformstringNo
isbootvolumeformstringNo
backuphostformstringNo
sensitivityformstringNo
consistencymodeformstringNo
modifiedbytesformstringNo
originatingudsformstringNo
hostconsistencydateformstringNo
systemstateMemoryformstringNo
expirytriesformstringNo
vmnameformstringNo
characteristicformstringNo
capacityformstringNo
policyidformstringNo
poolidformstringNo
targetclusterformstringNo
uniqueidformstringNo
systemstateBootDiskSizeformstringNo
transportformstringNo
esxhostformstringNo
targetformstringNo
targetudsformstringNo
depthformstringNo
componenttypeformstringNo
readyvmformstringNo
isbootvmdkformstringNo
logicalnameformstringNo
originalappidformstringNo
BackupResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformTypeBackupNo
ResponseStatusformResponseStatusNo
TypeSLA Parameters:
NameParameterData TypeRequiredDescription
idformintNo
modifydateformDateTimeNo
expirationoffformboolNo
slpidformintNo
descriptionformstringNo
createdateformDateTimeNo
dedupasyncoffformboolNo
appidformintNo
scheduleoffformboolNo
sltidformintNo

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"orgUserName":"String","isRemote":false,"sessionId":"String","datacenterLocation":"String","orgName":"String"}

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

{"hostname":"String","result":{"result":[{"friendlypath":"String","svcname":"String","installeddate":"\/Date(-62135596800000-0000)\/","ostype":"String","ipaddress":"String","uniquename":"String","osversion":"String","alternateip":"String","id":"String","originalhostid":"String","timezone":"String","description":"String","isclusterhost":false,"vcenterhostid":"String","modifydate":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","statusCode":"String","hostApp":{"id":0,"auxinfo":"String","protectable":"String","appversion":"String","morecredentials":"String","volumes":"String","username":"String","hostid":0,"lastfailover":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","jobclass":"String","flags":0,"sourceuds":0,"status":"String","expiration":"\/Date(-62135596800000-0000)\/","hostname":"String","appid":0,"label":"String","policyname":"String","consistencydate":"\/Date(-62135596800000-0000)\/","id":0,"backupdate":"\/Date(-62135596800000-0000)\/","mountedhost":0,"username":"String","backupname":"String","sltname":"String","sourceimage":"String","prepdate":"\/Date(-62135596800000-0000)\/","slpname":"String","appname":"String","apptype":"String","datastore":"String","vmpath":"String","sla":{"id":0,"modifydate":"\/Date(-62135596800000-0000)\/","expirationoff":false,"slpid":0,"description":"String","createdate":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","expirationoff":false,"slpid":0,"description":"String","createdate":"\/Date(-62135596800000-0000)\/","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"}}}