Veeam Backup & Replication 13
REST API Reference
Related documents

Sessions

The Sessions section defines paths and operations for managing sessions (except automation sessions) and task sessions performed on the backup server.

Get All Sessions

The HTTP GET request to the /api/v1/sessions path allows you to get an array of sessions performed on the backup server.

Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator, Veeam Security Administrator.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of sessions to skip.

limit
integer <int32>
Default: 200

Maximum number of sessions to return.

orderColumn
string (ESessionsFiltersOrderColumn)

Sorts sessions by one of the session parameters.

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

If true, sorts sessions in the ascending order by the orderColumn parameter.

nameFilter
string

Filters sessions by the nameFilter pattern. The pattern can match any session parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.

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
Array of strings (ESessionType)

Filters sessions by session type.

Items 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" "PublishBackupContentViaNfs" "VolumesDiscover" "DeleteBackup" "BackgroundOperation" "AgentDiscovery" "AgentPolicy" "AgentBackup" "ApplianceUpdatesInstall" "FailoverPlan" "FailoverPlanTask" "UnstructuredDataBrowse" "UnstructuredDownloadMeta" "EntraIdRescanRepository" "HostComponentsUpdate" "CopyBackup" "FileBackupHealthCheck" "ArchiveBackup" "ArchiveRehydration" "ArchiveSync" "ArchiveCopy" "ArchiveFreezing" "RetrieveBackup" "ArchiveTierDownload" "DirectBackupSync" "CheckpointRemoval" "Retention"
stateFilter
string (ESessionState)

Filters sessions by session state.

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

Filters sessions by session result.

Items Enum: "None" "Success" "Warning" "Failed"
jobIdFilter
string <uuid>

Filters sessions by job ID.

header Parameters
x-api-version
required
string
Default: 1.3-rev0

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.

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/sessions
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Session
The HTTP GET request to the /api/v1/sessions/{id} path allows you to get a session that has the specified id.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Session ID. To get the ID, run the Get All Sessions request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
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/sessions/{id}
Request samples 
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "resourceId": null,
  • "resourceReference": null,
  • "parentSessionId": null,
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Get Session Logs
The HTTP GET request to the /api/v1/sessions/{id}/logs path allows you to get an array of log records of a session that has the specified id.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Session ID. To get the ID, run the Get All Sessions request.


 
query Parameters
statusFilter
string (ETaskLogRecordStatus) 
Filters task session logs by status.


 Enum: "None" "Succeeded" "Warning" "Failed"  
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
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/sessions/{id}/logs
Request samples 
Response samples 
application/json
{
  • "totalRecords": 11,
  • "records": [
    ]
}
Stop Session
The HTTP POST request to the /api/v1/sessions/{id}/stop path allows you to stop a session that has the specified id.
 Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Session ID. To get the ID, run the Get All Sessions request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
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.


post/api/v1/sessions/{id}/stop
Request samples 
Response samples 
application/json
{ }
Get Task Sessions For Specified Session
The HTTP GET request to the /api/v1/sessions/{id}/taskSessions path allows you to get an array of task sessions performed on the backup server for the session that has the specified id .
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Tape Operator, Veeam Backup Viewer.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Session ID. To get the ID, run the Get All Sessions request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
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.


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/sessions/{id}/taskSessions
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get All Task Sessions
The HTTP GET request to the /api/v1/taskSessions path allows you to get an array of task sessions performed on the backup server.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Tape Operator, Veeam Backup Viewer.


SecurityBearer 
Request 
query Parameters
skip
integer <int32> 
Number of task sessions to skip.


 
limit
integer <int32> 
 Default:  200
Maximum number of task sessions to return.


 
orderColumn
string (ETaskSessionsFiltersOrderColumn) 
Sorts task sessions by one of the task session parameters.


 Enum: "Name" "Type" "SessionType" "CreationTime" "EndTime" "State" "Result" "ScanState" "ScanResult"  
orderAsc
boolean
If true, sorts task sessions in the ascending order by the orderColumn parameter.


 
nameFilter
string
Filters task sessions by the nameFilter pattern. The pattern can match any task session parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.


 
typeFilter
string (ETaskSessionType) 
Filters task sessions by the task session type.


 Enum: "Backup" "Restore" "Antivirus" "Replica"  
sessionTypeFilter
string (ESessionType) 
Filters task 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" "PublishBackupContentViaNfs" "VolumesDiscover" "DeleteBackup" "BackgroundOperation" "AgentDiscovery" "AgentPolicy" "AgentBackup" "ApplianceUpdatesInstall" "FailoverPlan" "FailoverPlanTask" "UnstructuredDataBrowse" "UnstructuredDownloadMeta" "EntraIdRescanRepository" "HostComponentsUpdate" "CopyBackup" "FileBackupHealthCheck" "ArchiveBackup" "ArchiveRehydration" "ArchiveSync" "ArchiveCopy" "ArchiveFreezing" "RetrieveBackup" "ArchiveTierDownload" "DirectBackupSync" "CheckpointRemoval" "Retention"  
createdAfterFilter
string <date-time> 
Returns task sessions that are created after the specified date and time.


 
createdBeforeFilter
string <date-time> 
Returns task sessions that are created before the specified date and time.


 
endedAfterFilter
string <date-time> 
Returns task sessions that are finished after the specified date and time.


 
endedBeforeFilter
string <date-time> 
Returns task sessions that are finished before the specified date and time.


 
stateFilter
string (ESessionState) 
Filters task sessions by task session state.


 Enum: "Stopped" "Starting" "Stopping" "Working" "Pausing" "Resuming" "WaitingTape" "Idle" "Postprocessing" "WaitingRepository" "WaitingSlot"  
resultFilter
string (ESessionResult) 
Filters task sessions by task session result.


 Enum: "None" "Success" "Warning" "Failed"  
scanTypeFilter
string (EAntivirusScanType) 
Filters task sessions by scan type.


 Enum: "Antivirus" "Yara"  
scanResultFilter
string (EAntivirusScanResult) 
Filters task sessions by scan result.


 Enum: "None" "Clean" "Infected" "Failed" "Canceled" "Inconclusive"  
scanStateFilter
string (EAntivirusScanState) 
Filters task sessions by scan state.


 Enum: "NotStarted" "InProgress" "Finished"  
sessionIdFilter
string <uuid> 
Filters task sessions by session id.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
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.


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/taskSessions
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Task Session
The HTTP GET request to the /api/v1/taskSessions/{id} path allows you to get a task session that has the specified id.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Tape Operator, Veeam Backup Viewer.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Task session ID. To get the ID, run the Get All Task Sessions request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
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/taskSessions/{id}
Request samples 
Response samples 
application/json
{
  • "algorithm": "Increment",
  • "state": "Stopped",
  • "name": "linbase01",
  • "restorePointId": "e7853593-49ac-49d9-be48-bcf98bf330f7",
  • "restorePointReference": "/api/v1/restorePoints/e7853593-49ac-49d9-be48-bcf98bf330f7",
  • "repositoryId": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec",
  • "usn": 129809,
  • "result": {
    },
  • "progress": {
    },
  • "type": "Backup",
  • "sessionType": "BackupJob",
  • "id": "3d995992-0230-42ef-bb30-ae8da82ea24a",
  • "sessionId": "54979d08-a3a2-44b7-bbfe-6703585d58a3",
  • "creationTime": "2024-11-09T18:00:30.407023",
  • "endTime": "2024-11-09T18:04:09.960857"
}
Get Task Session Logs
The HTTP GET request to the /api/v1/taskSessions/{id}/logs path allows you to get logs for a task session that has the specified id.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Tape Operator, Veeam Backup Viewer.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Task session ID. To get the ID, run the Get All Task Sessions request.


 
query Parameters
statusFilter
string (ETaskLogRecordStatus) 
Filters task session logs by status.


 Enum: "None" "Succeeded" "Warning" "Failed"  
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
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/taskSessions/{id}/logs
Request samples 
Response samples 
application/json
{
  • "totalRecords": 17,
  • "records": [
    ]
}