Net3 API Interface for Customer Portal

<back to all web services

RecoveryUsages

The following routes are available for this service:
POST/recovery/manager/usagesRetrieve estimated Usages for Recovery based on potential schedule
RecoveryUsages Parameters:
NameParameterData TypeRequiredDescription
initialDatasetSizebodydoubleYes
projectedDatasetSizebodydoubleYes
changeRateYOYbodydoubleYes
changeRatebodydoubleYes
schedulebodyProtectionScheduleYes
retentionbodyProtectionRetention[]Yes
bandwidthUsagesbodyBandwidthUsagesYes
ProtectionSchedule Parameters:
NameParameterData TypeRequiredDescription
backupCountformintNo
backupFrequencyformBackupFrequencyNo
backupHoursJournalformintNo
BackupFrequency Enum:
Unset
Daily
Hourly
Weekly
Monthly
Yearly
Continuous
ProtectionRetention Parameters:
NameParameterData TypeRequiredDescription
retentionCountformintNo
backupFrequencyformBackupFrequencyNo
BandwidthUsages Parameters:
NameParameterData TypeRequiredDescription
BandwidthAvailableformBandwidthAvailableNo
BandwidthRequiredformBandwidthRequiredNo
DataSyncformDataSyncNo
BandwidthAvailable Parameters:
NameParameterData TypeRequiredDescription
AvailableBandwidthMBformdoubleNo
AvailableBandwidthHoursPerDayformintNo
BandwidthRequired Parameters:
NameParameterData TypeRequiredDescription
RequiredNetworkBandwidthMbpsformdoubleNo
DataSync Parameters:
NameParameterData TypeRequiredDescription
InitialSyncHoursAllowedformintNo
DataCompressionPercentExpectedformdoubleNo
NetworkEfficiencyPercentExpectedformdoubleNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /recovery/manager/usages HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"initialDatasetSize":0,"projectedDatasetSize":0,"changeRateYOY":0,"changeRate":0,"schedule":{"backupCount":0,"backupFrequency":"Unset","backupHoursJournal":0},"retention":[{"retentionCount":0,"backupFrequency":"Unset"}],"bandwidthUsages":{"bandwidthAvailable":{"availableBandwidthMB":0,"availableBandwidthHoursPerDay":0},"bandwidthRequired":{"requiredNetworkBandwidthMbps":0},"dataSync":{"initialSyncHoursAllowed":0,"dataCompressionPercentExpected":0,"networkEfficiencyPercentExpected":0}}}