Net3 API Interface for Customer Portal

BackupOnDemand

The following routes are available for this service:
POST	/backup/{sessionId}/appid/{appid}/datacenter/{datacenterLocation}/policy/{policyid}

**BackupBase** Parameters:
Name	Parameter	Data Type	Required	Description
sessionId	form	string	No
datacenterLocation	form	string	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 .xml suffix or ?format=xml

HTTP + XML

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

POST /backup/{sessionId}/appid/{appid}/datacenter/{datacenterLocation}/policy/{policyid} HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BackupOnDemand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <_x003C_Content_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_Content_x003E_k__BackingField>
  <_x003C_errorCode_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">0</_x003C_errorCode_x003E_k__BackingField>
  <_x003C_errorMessage_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_errorMessage_x003E_k__BackingField>
  <_x003C_errorStatus_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">false</_x003C_errorStatus_x003E_k__BackingField>
  <_x003C_StatusCode_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_StatusCode_x003E_k__BackingField>
  <_x003C_jobid_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_jobid_x003E_k__BackingField>
  <_x003C_appid_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">0</_x003C_appid_x003E_k__BackingField>
  <_x003C_appname_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_appname_x003E_k__BackingField>
  <_x003C_apptype_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_apptype_x003E_k__BackingField>
  <_x003C_backupdate_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">0001-01-01T00:00:00</_x003C_backupdate_x003E_k__BackingField>
  <_x003C_backuphost_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_backuphost_x003E_k__BackingField>
  <_x003C_backuplock_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_backuplock_x003E_k__BackingField>
  <_x003C_backupname_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_backupname_x003E_k__BackingField>
  <_x003C_capacity_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_capacity_x003E_k__BackingField>
  <_x003C_catalogstate_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_catalogstate_x003E_k__BackingField>
  <_x003C_characteristic_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_characteristic_x003E_k__BackingField>
  <_x003C_componenttype_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_componenttype_x003E_k__BackingField>
  <_x003C_consistencydate_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">0001-01-01T00:00:00</_x003C_consistencydate_x003E_k__BackingField>
  <_x003C_consistencymode_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_consistencymode_x003E_k__BackingField>
  <_x003C_datastore_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_datastore_x003E_k__BackingField>
  <_x003C_depth_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_depth_x003E_k__BackingField>
  <_x003C_dnsname_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_dnsname_x003E_k__BackingField>
  <_x003C_esxhost_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_esxhost_x003E_k__BackingField>
  <_x003C_expiration_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">0001-01-01T00:00:00</_x003C_expiration_x003E_k__BackingField>
  <_x003C_expirytries_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_expirytries_x003E_k__BackingField>
  <_x003C_filename_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_filename_x003E_k__BackingField>
  <_x003C_flags_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">0</_x003C_flags_x003E_k__BackingField>
  <_x003C_hostconsistencydate_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_hostconsistencydate_x003E_k__BackingField>
  <_x003C_hostname_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_hostname_x003E_k__BackingField>
  <_x003C_id_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">0</_x003C_id_x003E_k__BackingField>
  <_x003C_isbootvmdk_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_isbootvmdk_x003E_k__BackingField>
  <_x003C_isbootvolume_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_isbootvolume_x003E_k__BackingField>
  <_x003C_jobclass_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_jobclass_x003E_k__BackingField>
  <_x003C_label_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_label_x003E_k__BackingField>
  <_x003C_logicalname_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_logicalname_x003E_k__BackingField>
  <_x003C_logtruncated_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_logtruncated_x003E_k__BackingField>
  <_x003C_mappedhost_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_mappedhost_x003E_k__BackingField>
  <_x003C_modifiedbytes_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_modifiedbytes_x003E_k__BackingField>
  <_x003C_modifydate_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">0001-01-01T00:00:00</_x003C_modifydate_x003E_k__BackingField>
  <_x003C_mountedhost_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">0</_x003C_mountedhost_x003E_k__BackingField>
  <_x003C_nasstaging_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_nasstaging_x003E_k__BackingField>
  <_x003C_nvolumes_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_nvolumes_x003E_k__BackingField>
  <_x003C_originalappid_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_originalappid_x003E_k__BackingField>
  <_x003C_originalbackupid_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">0</_x003C_originalbackupid_x003E_k__BackingField>
  <_x003C_originatingcluster_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_originatingcluster_x003E_k__BackingField>
  <_x003C_originatinguds_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_originatinguds_x003E_k__BackingField>
  <_x003C_policyid_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_policyid_x003E_k__BackingField>
  <_x003C_policyname_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_policyname_x003E_k__BackingField>
  <_x003C_poolid_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_poolid_x003E_k__BackingField>
  <_x003C_prepdate_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">0001-01-01T00:00:00</_x003C_prepdate_x003E_k__BackingField>
  <_x003C_preserved_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_preserved_x003E_k__BackingField>
  <_x003C_readyvm_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_readyvm_x003E_k__BackingField>
  <_x003C_restorableobject_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_restorableobject_x003E_k__BackingField>
  <_x003C_restorelock_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_restorelock_x003E_k__BackingField>
  <_x003C_sensitivity_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_sensitivity_x003E_k__BackingField>
  <_x003C_sla_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">
    <_x003C_appid_x003E_k__BackingField>0</_x003C_appid_x003E_k__BackingField>
    <_x003C_createdate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_createdate_x003E_k__BackingField>
    <_x003C_dedupasyncoff_x003E_k__BackingField>false</_x003C_dedupasyncoff_x003E_k__BackingField>
    <_x003C_description_x003E_k__BackingField>String</_x003C_description_x003E_k__BackingField>
    <_x003C_expirationoff_x003E_k__BackingField>false</_x003C_expirationoff_x003E_k__BackingField>
    <_x003C_id_x003E_k__BackingField>0</_x003C_id_x003E_k__BackingField>
    <_x003C_modifydate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_modifydate_x003E_k__BackingField>
    <_x003C_scheduleoff_x003E_k__BackingField>false</_x003C_scheduleoff_x003E_k__BackingField>
    <_x003C_slpid_x003E_k__BackingField>0</_x003C_slpid_x003E_k__BackingField>
    <_x003C_sltid_x003E_k__BackingField>0</_x003C_sltid_x003E_k__BackingField>
  </_x003C_sla_x003E_k__BackingField>
  <_x003C_slpname_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_slpname_x003E_k__BackingField>
  <_x003C_sltname_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_sltname_x003E_k__BackingField>
  <_x003C_sourcecluster_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_sourcecluster_x003E_k__BackingField>
  <_x003C_sourceimage_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_sourceimage_x003E_k__BackingField>
  <_x003C_sourceuds_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">0</_x003C_sourceuds_x003E_k__BackingField>
  <_x003C_status_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_status_x003E_k__BackingField>
  <_x003C_systemstateBootDiskSize_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_systemstateBootDiskSize_x003E_k__BackingField>
  <_x003C_systemstateCPU_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_systemstateCPU_x003E_k__BackingField>
  <_x003C_systemstateMemory_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_systemstateMemory_x003E_k__BackingField>
  <_x003C_systemstateNIC_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_systemstateNIC_x003E_k__BackingField>
  <_x003C_systemstateOSType_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_systemstateOSType_x003E_k__BackingField>
  <_x003C_target_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_target_x003E_k__BackingField>
  <_x003C_targetcluster_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_targetcluster_x003E_k__BackingField>
  <_x003C_targetuds_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_targetuds_x003E_k__BackingField>
  <_x003C_transport_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_transport_x003E_k__BackingField>
  <_x003C_uniquehostname_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_uniquehostname_x003E_k__BackingField>
  <_x003C_uniqueid_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_uniqueid_x003E_k__BackingField>
  <_x003C_username_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_username_x003E_k__BackingField>
  <_x003C_virtualsize_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">0</_x003C_virtualsize_x003E_k__BackingField>
  <_x003C_vmname_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_vmname_x003E_k__BackingField>
  <_x003C_vmpath_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_vmpath_x003E_k__BackingField>
  <_x003C_volumekey_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_volumekey_x003E_k__BackingField>
  <_x003C_volumelabel_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">String</_x003C_volumelabel_x003E_k__BackingField>
  <datacenterLocation>String</datacenterLocation>
  <sessionId>String</sessionId>
</BackupOnDemand>