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

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

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

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

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

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

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

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

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

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