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 .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.

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

{
	result: 
	{
		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,
		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
		}
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}