Net3 API Interface for Customer Portal

<back to all web services

BackupApp

Requires Authentication
The following routes are available for this service:
GET/backupapp/{sessionId}/{id}/{datacenterLocation}
BackupApp Parameters:
NameParameterData TypeRequiredDescription
sessionIdpathstringNo
idpathstringNo
datacenterLocationpathstringNo

Allowable Values

  • GMU
  • SPA
  • LAS
  • DEV
  • VCD
  • AWS
  • GCP
  • UAT
  • AZU
  • AUV
  • ATL
BackupAppResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformTypeBackupApplicationNo
ResponseStatusformResponseStatusNo
TypeBackupApplication Parameters:
NameParameterData TypeRequiredDescription
idformintNo
auxinfoformstringNo
protectableformstringNo
appversionformstringNo
morecredentialsformstringNo
volumesformstringNo
usernameformstringNo
hostidformintNo
lastfailoverformDateTimeNo
descriptionformstringNo
appnameformstringNo
sourceclusterformlongNo
originalappidformintNo
apptypeformstringNo
failoverstateformstringNo
friendlytypeformstringNo
ignoreformboolNo
networknameformstringNo
networkipformstringNo
pathnameformstringNo
isclusteredformboolNo
slaformTypeSLANo
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 .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.

GET /backupapp/{sessionId}/{id}/{datacenterLocation} HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BackupAppResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TDataBroker.Models">
    <d2p1:_x003C_appname_x003E_k__BackingField>String</d2p1:_x003C_appname_x003E_k__BackingField>
    <d2p1:_x003C_apptype_x003E_k__BackingField>String</d2p1:_x003C_apptype_x003E_k__BackingField>
    <d2p1:_x003C_appversion_x003E_k__BackingField>String</d2p1:_x003C_appversion_x003E_k__BackingField>
    <d2p1:_x003C_auxinfo_x003E_k__BackingField>String</d2p1:_x003C_auxinfo_x003E_k__BackingField>
    <d2p1:_x003C_description_x003E_k__BackingField>String</d2p1:_x003C_description_x003E_k__BackingField>
    <d2p1:_x003C_failoverstate_x003E_k__BackingField>String</d2p1:_x003C_failoverstate_x003E_k__BackingField>
    <d2p1:_x003C_friendlytype_x003E_k__BackingField>String</d2p1:_x003C_friendlytype_x003E_k__BackingField>
    <d2p1:_x003C_hostid_x003E_k__BackingField>0</d2p1:_x003C_hostid_x003E_k__BackingField>
    <d2p1:_x003C_id_x003E_k__BackingField>0</d2p1:_x003C_id_x003E_k__BackingField>
    <d2p1:_x003C_ignore_x003E_k__BackingField>false</d2p1:_x003C_ignore_x003E_k__BackingField>
    <d2p1:_x003C_isclustered_x003E_k__BackingField>false</d2p1:_x003C_isclustered_x003E_k__BackingField>
    <d2p1:_x003C_lastfailover_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_lastfailover_x003E_k__BackingField>
    <d2p1:_x003C_morecredentials_x003E_k__BackingField>String</d2p1:_x003C_morecredentials_x003E_k__BackingField>
    <d2p1:_x003C_networkip_x003E_k__BackingField>String</d2p1:_x003C_networkip_x003E_k__BackingField>
    <d2p1:_x003C_networkname_x003E_k__BackingField>String</d2p1:_x003C_networkname_x003E_k__BackingField>
    <d2p1:_x003C_originalappid_x003E_k__BackingField>0</d2p1:_x003C_originalappid_x003E_k__BackingField>
    <d2p1:_x003C_pathname_x003E_k__BackingField>String</d2p1:_x003C_pathname_x003E_k__BackingField>
    <d2p1:_x003C_protectable_x003E_k__BackingField>String</d2p1:_x003C_protectable_x003E_k__BackingField>
    <d2p1:_x003C_sla_x003E_k__BackingField>
      <d2p1:_x003C_appid_x003E_k__BackingField>0</d2p1:_x003C_appid_x003E_k__BackingField>
      <d2p1:_x003C_createdate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_createdate_x003E_k__BackingField>
      <d2p1:_x003C_dedupasyncoff_x003E_k__BackingField>false</d2p1:_x003C_dedupasyncoff_x003E_k__BackingField>
      <d2p1:_x003C_description_x003E_k__BackingField>String</d2p1:_x003C_description_x003E_k__BackingField>
      <d2p1:_x003C_expirationoff_x003E_k__BackingField>false</d2p1:_x003C_expirationoff_x003E_k__BackingField>
      <d2p1:_x003C_id_x003E_k__BackingField>0</d2p1:_x003C_id_x003E_k__BackingField>
      <d2p1:_x003C_modifydate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_modifydate_x003E_k__BackingField>
      <d2p1:_x003C_scheduleoff_x003E_k__BackingField>false</d2p1:_x003C_scheduleoff_x003E_k__BackingField>
      <d2p1:_x003C_slpid_x003E_k__BackingField>0</d2p1:_x003C_slpid_x003E_k__BackingField>
      <d2p1:_x003C_sltid_x003E_k__BackingField>0</d2p1:_x003C_sltid_x003E_k__BackingField>
    </d2p1:_x003C_sla_x003E_k__BackingField>
    <d2p1:_x003C_sourcecluster_x003E_k__BackingField>0</d2p1:_x003C_sourcecluster_x003E_k__BackingField>
    <d2p1:_x003C_username_x003E_k__BackingField>String</d2p1:_x003C_username_x003E_k__BackingField>
    <d2p1:_x003C_volumes_x003E_k__BackingField>String</d2p1:_x003C_volumes_x003E_k__BackingField>
  </Result>
</BackupAppResponse>