Veeam Backup & Replication 13
REST API Reference
Related documents

Application Items Restore

The Application Items Restore section defines operations for managing application item restore sessions performed with Veeam Explorers.

Get All Child Restore Sessions for Application Item Browse Session

The HTTP GET request to the /api/v1/restore/applicationItems/{browseSessionId}/childSessions endpoint gets an array of restore sessions associated with the application item browse session that has the specified browseSessionId.

Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.

SecurityBearer
Request
path Parameters
browseSessionId
required
string <uuid>

Browse session ID.

query Parameters
skip
integer <int32>

Number of mount sessions to skip.

limit
integer <int32>
Default: 200

Maximum number of mount sessions to return.

orderColumn
string (ESessionsFiltersOrderColumn)

Sorts mounts by one of the mount sessions parameters.

Enum: "Name" "SessionType" "CreationTime" "EndTime" "State" "Result" "InitiatedBy"
orderAsc
boolean

Sorts mount sessions in ascending order by the orderColumn parameter.

createdAfterFilter
string <date-time>

Returns sessions that are created after the specified date and time.

createdBeforeFilter
string <date-time>

Returns sessions that are created before the specified date and time.

endedAfterFilter
string <date-time>

Returns sessions that are finished after the specified date and time.

endedBeforeFilter
string <date-time>

Returns sessions that are finished before the specified date and time.

typeFilter
string (ESessionType)

Filters sessions by session type.

Enum: "Infrastructure" "BackupJob" "Automation" "ConfigurationBackup" "PublishBackupContentViaMount" "RepositoryMaintenance" "RepositoryEvacuate" "InfrastructureItemDeletion" "RestoreVm" "InstantRecovery" "FirstClassDiskInstantRestore" "AzureApplianceDeploy" "QuickMigration" "FileLevelRestore" "LinuxFileLevelRestore" "ReplicaJob" "ConfigurationResynchronize" "Failover" "PlannedFailover" "PermanentFailover" "UndoFailover" "Failback" "CommitFailback" "UndoFailback" "SwitchReplicaToProduction" "CloudDirectorVmRestore" "CloudDirectorVAppRestore" "MalwareDetection" "FirstClassDiskQuickMigration" "EntraIdRestore" "EntraIdRestoreFromCopy" "UnstructuredDataBackupCopy" "SecurityComplianceAnalyzer" "FileServerSave" "SureBackup" "NasRestore" "LogsExport" "TestCredentials" "SqlLogBackup" "OracleLogBackup" "PostgreSqlLogBackup" "AzureInstantRecovery" "AzureInstantRecoveryMigration" "AzureInstantRecoverySwitchover" "AzureInstantRecoveryStart" "AzureInstantRecoveryStop" "AzureInstantRecoveryMigrationUndo" "AzureInstantRecoveryMount" "FileInstantRecovery" "FileInstantRecoveryMigration" "PublishBackupContentViaNfs" "VolumesDiscover" "DeleteBackup" "BackgroundOperation" "AgentDiscovery" "AgentPolicy" "AgentBackup" "AgentOperationPurgeCache" "ApplianceUpdatesInstall" "FailoverPlan" "FailoverPlanTask" "UnstructuredDataBrowse" "BackupCopyJob" "UnstructuredDownloadMeta" "EntraIdRescanRepository" "HostComponentsUpdate" "CopyBackup" "FileBackupHealthCheck" "SureBackupContentScan" "ArchiveBackup" "ArchiveRehydration" "ArchiveSync" "ArchiveCopy" "ArchiveFreezing" "RetrieveBackup" "ArchiveTierDownload" "DirectBackupSync" "CheckpointRemoval" "IrisBackup" "Retention" "PlatformServiceJob" "PlatformBackupJob" "PlatformSnapshotJob" "PlatformSnapshotCopyJob" "AgentOperationBackupNow" "AgentOperationActiveFull" "AgentManagement" "BackupCopyJobParent" "ApplicationLevelRestore" "EncryptionAnalysis" "VeeamUpdaterSettingsSync" "EndpointBackup" "StorageDiscovery" "StorageMonitoring" "AdForestRestore" "AgentsRecoveryAppliancesManagement" "RestoreRecoveryApplianceVolumes" "RestoreAgentVolumes" "EndpointRestore" "EpAgentOperationStopBackup" "BackupCacheSync" "PerVmMoveBackup" "PerVmCopyBackup" "FileBackupArchiveRetrievalProlonging" "HaSwitchover" "IndexCollection" "InstantDiskRecovery" "DiskRestore" "HaClusterEdit"
stateFilter
string (ESessionState)

Filters sessions by session state.

Enum: "Stopped" "Starting" "Stopping" "Working" "Pausing" "Resuming" "WaitingTape" "Idle" "Postprocessing" "WaitingRepository" "WaitingSlot" "ActionRequired"
resultFilter
Array of strings (ESessionResult)

Filters sessions by session result.

Items Enum: "None" "Success" "Warning" "Failed"
header Parameters
x-api-version
required
string
Default: 1.3-rev2

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Responses
200

OK

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

404

Not found. No object was found with the path parameter specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v1/restore/applicationItems/{browseSessionId}/childSessions
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}