Dell Appassure 5 User Guide

							Dell AppAssure User Guide
Version 5.4.3 Revision B479
GetApiVersionInfo
Obtains the release version information for the API.
URI: servicehost/apiVersion
HTTP Method: GET
GetConfiguration
Gets current configuration of a server that listens for incoming REST calls.
URI: servicehost/config
HTTP Method: GET
Restart
Immediately restarts a server that listens for incoming REST calls.
URI: servicehost/restart
HTTP Method: GET
SetConfiguration
Sets current configuration of a server that listens for incoming REST calls.
URI: servicehost/config
HTTP Method: POST
Ve r i f y C o n n e c t i o n
Allows to verify if listening server is configured properly and able to receive incoming REST calls.
URI: servicehost/verify
HTTP Method: GET
ISqlManagement
This section describes the service operations available for ISqlManagement at sql/. 
The ISqlManagement service contract is the interface implemented by core sql management service which 
provides attachability checks and other core-specific SQL management functionality.
The URI and HTTP method are provided for each service operation.
The service operations include:
•ForceAttachability
•GetAttachabilitySettings
•GetCoreSqlInstances
•SetAttachabilitySettings
•TestSqlConnection
ForceAttachab ility
Force attachability job for agent with given ID.
URI: sql/recoveryPoints/{recoveryPointId}/force
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B480
GetAttachabilitySettings
Gets core-level attachability settings.
URI: sql/attachabilitySettings
HTTP Method: GET
GetCoreSqlInstances
Gets core-level attachability settings.
URI: sql/coreSqlInstances
HTTP Method: GET
SetAttachabilitySettings
Gets core-level attachability settings.
URI: sql/attachabilitySettings
HTTP Method: PUT
TestSqlConnection
Sets core-level attachability settings.
URI: sql/connection
HTTP Method: PUT
IStatusSummaryManagement
This section describes the service operations available for IStatusSummaryManagement at status/. 
The IStatusSummaryManagement service contract exposes summarized status info about multiple services in the 
core for use displaying status icons in the GUI tabs.
The URI and HTTP method are provided for each service operation.
The service operations include:
•Crash
•GetAgentDashboardInfo
•GetCoreEventsInfo
•GetCoreHomeInfo
•GetCoreSystemInfo
•GetDashboardInfo
•GetFailedServicesInfo
•GetLatestEvents
•GetStatusSummary
•RetryStartFailedServices
Crash
Crashes the process.
URI: status/crash
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B481
GetAgentDashboardInfo
Get the status info for a specific Agent.
URI: status/dashboard/{agentId}
HTTP Method: GET
GetCoreEventsInfo
Gets latest core events info such as events accumulated since last call to itself or start of core if call is first.
URI: status/coreEventsInfo
HTTP Method: POST
GetCoreHomeInfo
Gets core metadata and recent 10 alerts.
URI: status/coreHomeInfo
HTTP Method: GET
GetCoreSystemInfo
Gets core system info such as mounts, metadata, settings, repository configuration, and so on.
URI: status/coreSystemInfo
HTTP Method: GET
GetDashboardInfo
Get the status info necessary to display the dashboard on the main screen.
URI: status/dashboard
HTTP Method: GET
GetFailedServicesInfo
Gets names of services failed to initialize.
URI: status/failedServicesInfo
HTTP Method: GET
GetLatestEvents
Gets latest core events info such as events accumulated since last call to itself or start of core if call is first.
URI: status/latestEventsInfo
HTTP Method: GET
GetStatusSummary
Get a summary of the status of all services including in the status summary API.
URI: status/statusSummary
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B482
RetryStartFailedServices
Tries to restart failed services.
URI: status/restart/
HTTP Method: POST
ITransferQueueManagement
This section describes the service operations available for ITransferQueueManagement at xfer/queue/. 
The ITransferQueueManagement service contract is the RESTful API for the transfer queue.
The URI and HTTP method are provided for each service operation.
The service operations include:
•AdjustTransferPriority
•CancelAllTransfers
•CancelTransfer
•GetActiveQueueEntries
•GetEntryInfo
•GetPendingQueueEntries
•GetQueueConfiguration
•GetQueueContents
•SetQueueConfiguration
AdjustTransferPriority
Adjusts the priority of the transfer in the queue.
URI: xfer/queue/entries/{transferid}
HTTP Method: POST
CancelAllTransfers
Cancels every transfer in the queue.
URI: xfer/queue/entries
HTTP Method: DELETE
CancelTransfer
Cancels the transfer queue entry identified by the transfer ID.
URI: xfer/queue/entries/{transferid}
HTTP Method: DELETE
GetActiveQueueEntries
Gets the active entries in the transfer queue.
URI: xfer/queue/activeEntries
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B483
GetEntryInfo
Gets the info for a specific transfer queue entry.
URI: xfer/queue/entries/{transferid}
HTTP Method: GET
GetPendingQueueEntries
Gets the pending entries in the transfer queue.
URI: xfer/queue/pendingEntries
HTTP Method: GET
GetQueueConfiguration
Gets the configuration of the transfer queue.
URI: xfer/queue/config
HTTP Method: GET
GetQueueContents
Gets the contents of the transfer queue.
URI: xfer/queue/entries
HTTP Method: GET
SetQueueConfiguration
Sets the configuration of the transfer queue.
URI: xfer/queue/config
HTTP Method: POST
ITransferSchedulerManagement
This section describes the service operations available for ITransferSchedulerManagement at xfer/schedule/. 
The ITransferSchedulerManagement service contract is the RESTful API for the transfer scheduler.
The URI and HTTP method are provided for each service operation.
The service operations include:
•AddScheduleTemplate
•ApplyRepositoryToUnprotectedAgents
•BatchAgentsProtectionPaused
•BatchAgentsProtectionResumed
•DeleteScheduleTemplate
•ForceAllTransfer
•ForceTransfer
•GetActualAgentProtectionConfiguration
•GetAgentConfiguration
•GetCachedAgentProtectionConfiguration
•GetScheduleTemplate 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B484 •GetScheduleTemplates
•RemoveRepositoryFromProtection
•SetAgentConfiguration
•SetAgentProtectionConfiguration
•UpdateScheduleTemplate
AddScheduleTemplate
Gets the transfer schedule templates collection.
URI: xfer/schedule/transferScheduleTemplates
HTTP Method: POST
ApplyRepositoryToUnprotectedAgents
Applies a new repository to agents that do not have a repository.
URI: xfer/schedule/applyrepository/{repositoryName}
HTTP Method: PUT
BatchAgentsProtectionPaused
Pauses protection of several agents.
URI: xfer/schedule/agentsPaused
HTTP Method: POST
BatchAgentsProtectionResumed
Resumes protection of several agents.
URI: xfer/schedule/agentsResumed
HTTP Method: POST
DeleteScheduleTemplate
Removes transfer schedule template.
URI: xfer/schedule/transferScheduleTemplates/{templateId}
HTTP Method: DELETE
ForceAllTransfer
Forces an immediate transfer for all available agents.
URI: xfer/schedule/forcealltransfer
HTTP Method: POST
ForceTransfer
Forces an immediate transfer of the specified protection group.
URI: xfer/schedule/{agentId}/transfer
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B485
GetActualAgentProtectionConfiguration
Gets the actual protection groups configured for the agent.
URI: xfer/schedule/{agentId}/actualProtectionConfiguration
HTTP Method: GET
GetAgentConfiguration
Gets the transfer configuration settings for the agent.
URI: xfer/schedule/{agentId}/config
HTTP Method: GET
GetCachedAgentProtectionConfiguration
Sets the protection groups configured for the agent.
URI: xfer/schedule/{agentId}/pgs
HTTP Method: GET
GetScheduleTemplate
Gets the transfer schedule template by id.
URI: xfer/schedule/transferScheduleTemplates/{templateId}
HTTP Method: GET
GetScheduleTemplates
Gets the transfer schedule templates collection.
URI: xfer/schedule/transferScheduleTemplates
HTTP Method: GET
RemoveRepositoryFromProtection
Disassociates agents from a named repository (for example, one that has been deleted).
URI: xfer/schedule/removerepository/{repositoryName}
HTTP Method: DELETE
SetAgentConfiguration
Sets the transfer configuration settings for the agent.
URI: xfer/schedule/{agentId}/config
HTTP Method: PUT
SetAgentProtectionConfiguration
Sets the protection groups configured for the agent.
URI: xfer/schedule/{agentId}/pgs
HTTP Method: PUT 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B486
UpdateScheduleTemplate
Updates existing transfer schedule template.
URI: xfer/schedule/transferScheduleTemplates/{templateId}
HTTP Method: PUT
IUtilitiesManagement
This section describes the service operations available for IUtilitiesManagement at utilities/. The 
IUtilitiesManagement service contract is the API for variety helpers.
The URI and HTTP method are provided for each service operation.
The service operations include:
•GetDomainInfo
•GetMachinesFromActiveDirectory
•GetMachinesFromActiveDirectoryByPage
GetDomainInfo
Gets domain information.
URI: utilities/domainInformation
HTTP Method: POST
GetMachinesFromActiveDirectory
Gets all machines from Active Directory.
URI: utilities/activeDirectoryMachines
HTTP Method: POST
GetMachinesFromActiveDirectoryByPage
Gets machines by specific page from Active Directory.
URI: utilities/activeDirectoryMachinesByPage
HTTP Method: POST
IVirtualDiskManagement
This section describes the service operations available for IVirtualDiskManagement at vhd/. The URI and HTTP 
method are provided for each service operation.
The service operations include:
•BaseFileName
•BeginBatch
•Close
•Create
•Delete
•EndBatch
•HasSnapshot 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B487 •Open
•Read
•ReadCustomMetadata
•SectorSize
•SnapshotFileName
•Ta k e S n a p s h o t
•TotalSectorCapacity
•TranslateSectorOffsetToChsTuple
•Wr i te
•WriteCustomMetadata
BaseFileName
Gets VHD base file name.
URI: vhd/{id}/baseFileName
HTTP Method: GET
BeginBatch
Begins batch.
URI: vhd/{id}/beginBatch/{target}
HTTP Method: POST
Close
Closes VHD.
URI: vhd/{id}/close
HTTP Method: GET
Create
Creates VHD.
URI: 
vhd/createVhd?path={path}&bytesCapacity={bytesCapacity}&bytesPerSector={bytesPerSector}&containsBootSys
temVolume={containsBootSystemVolume}&preallocate={preallocate}
HTTP Method: PUT
Delete
Deletes VHD snapshot or base file.
URI: vhd/{id}/delete/{target}
HTTP Method: POST
EndBatch
Ends batch.
URI: vhd/{id}/endBatch
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B488
HasSnapshot
Verifies VHD has snapshot.
URI: vhd/{id}/hasSnapshot
HTTP Method: GET
Open
Opens VHD.
URI: vhd/openVhd?path={path}
HTTP Method: PUT
Read
Writes raw data to VHD.
URI: vhd/{id}/read/{target}/{sectorOffset}/{sectorLength}
HTTP Method: POST
ReadCustomMetadata
Reads a user-defined custom metadata string.
URI: vhd/{id}/readCustomMetadata/{target}/{key}
HTTP Method: POST
SectorSize
Gets sector size of the VHD.
URI: vhd/{id}/sectorSize
HTTP Method: GET
SnapshotFileName
Gets VHD snapshot file name.
URI: vhd/{id}/snapshotFileName
HTTP Method: GET
Ta k e S n a p s h o t
Takes VHD snapshot.
URI: vhd/{id}/takeSnapshot
HTTP Method: GET
TotalSectorCapacity
Gets VHD capacity.
URI: vhd/{id}/totalSectorCapacity
HTTP Method: GET