Sessions

The Sessions section defines paths and operations for managing sessions (except automation 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.

SecurityBearer

Request

query Parameters

skip	integer <int32> Number of sessions to skip.
limit	integer <int32> Maximum number of sessions to return.
orderColumn	string (ESessionsFiltersOrderColumn) Sorts sessions by one of the session parameters. Enum: "Name" "SessionType" "CreationTime" "EndTime" "State" "Result"
orderAsc	boolean 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	string (ESessionType) Filters sessions by session type. Enum: "Infrastructure" "BackupJob" "Automation" "ConfigurationBackup" "RepositoryMaintenance" "RepositoryEvacuate" "InfrastructureItemDeletion" "RestoreVm" "InstantRecovery" "FirstClassDiskInstantRestore" "AzureApplianceDeploy" "QuickMigration" "FileLevelRestore" "LinuxFileLevelRestore" "ReplicaJob" "ConfigurationResynchronize" "Failover" "PlannedFailover" "PermanentFailover" "UndoFailover" "Failback" "CommitFailback" "UndoFailback" "SwitchReplicaToProduction" "CloudDirectorVmRestore" "CloudDirectorVAppRestore" "MalwareDetection" "FirstClassDiskQuickMigration"
stateFilter	string (ESessionState) Filters sessions by session state. Enum: "Stopped" "Starting" "Stopping" "Working" "Pausing" "Resuming" "WaitingTape" "Idle" "Postprocessing" "WaitingRepository" "WaitingSlot"
resultFilter	string (ESessionResult) Filters sessions by session result. Enum: "None" "Success" "Warning" "Failed"
jobIdFilter	string <uuid> Filters sessions by job ID.

header Parameters

x-api-version

required

string

Default: 1.1-rev2

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

Responses

200

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

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"data": [{"sessionType": "Job",
"state": "Stopped",
"id": "c924ee2f-1197-4b37-8de3-009c1977f347",
"name": "Backup Job 1",
"jobId": "c05dfa57-f59a-4e90-8065-b7f5d3276406",
"creationTime": "2021-12-04T06:13:34.983+01:00",
"endTime": "2021-12-04T06:15:00.617+01:00",
"progressPercent": 100,
"result": {"result": "Failed",
"message": "Creating synthetic full backup (22% done)",
"isCanceled": false
},
"resourceId": "c7478158-7c99-4bab-93b1-c3efdd1062fa",
"resourceReference": "/api/v1/backups/c7478158-7c99-4bab-93b1-c3efdd1062fa",
"parentSessionId": null,
"usn": 0
}
],
"pagination": {"total": 307,
"count": 1,
"skip": 0,
"limit": 1
}
}

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.

SecurityBearer

Request

path Parameters

required

string <uuid>

ID of the session.

header Parameters

x-api-version

required

string

Default: 1.1-rev2

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

Responses

200

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

curl
Python
JavaScript
C#
Go

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": "2021-11-08T10:00:12.56+01:00",
"endTime": "2021-11-08T10:00:34.017+01:00",
"progressPercent": 100,
"result": {"result": "Success",
"message": "Success",
"isCanceled": false
},
"resourceId": null,
"resourceReference": null,
"parentSessionId": null,
"usn": 0
}

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.

SecurityBearer

Request

path Parameters

required

string <uuid>

ID of the session.

header Parameters

x-api-version

required

string

Default: 1.1-rev2

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

Responses

200

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

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"totalRecords": 11,
"records": [{"status": "Warning",
"id": 11,
"startTime": "2021-11-05T06:03:15.866256+01:00",
"updateTime": "2021-11-05T06:03:15.866256+01:00",
"title": "Job finished with warning at 11/5/2021 6:03:15 AM ",
"description": ""
},
{"status": "Succeeded",
"id": 10,
"startTime": "2021-11-05T06:03:15.756877+01:00",
"updateTime": "2021-11-05T06:03:15.756877+01:00",
"title": "Primary bottleneck: Source",
"description": ""
},
{"status": "Succeeded",
"id": 9,
"startTime": "2021-11-05T06:03:15.647498+01:00",
"updateTime": "2021-11-05T06:03:15.647498+01:00",
"title": "Load: Source 86% > Proxy 54% > Network 56% > Target 42%",
"description": ""
},
{"status": "Succeeded",
"id": 7,
"startTime": "2021-11-05T06:00:24.096249+01:00",
"updateTime": "2021-11-05T06:03:08.2098022+01:00",
"title": "Processing ubuntu88",
"description": ""
},
{"status": "Succeeded",
"id": 5,
"startTime": "2021-11-05T06:00:18.9711163+01:00",
"updateTime": "2021-11-05T06:02:18.5413692+01:00",
"title": "Processing winsrv100",
"description": ""
},
{"status": "Succeeded",
"id": 6,
"startTime": "2021-11-05T06:00:24.0650043+01:00",
"updateTime": "2021-11-05T06:01:02.6441456+01:00",
"title": "Processing dbserver01",
"description": ""
},
{"status": "Succeeded",
"id": 8,
"startTime": "2021-11-05T06:00:59.2378014+01:00",
"updateTime": "2021-11-05T06:00:59.2378014+01:00",
"title": "All VMs have been queued for processing",
"description": ""
},
{"status": "Succeeded",
"id": 4,
"startTime": "2021-11-05T06:00:12.0178073+01:00",
"updateTime": "2021-11-05T06:00:12.0178073+01:00",
"title": "Changed block tracking is enabled",
"description": ""
},
{"status": "Succeeded",
"id": 3,
"startTime": "2021-11-05T06:00:12.0021761+01:00",
"updateTime": "2021-11-05T06:00:12.0021761+01:00",
"title": "VM size: 86 GB (48 GB used)",
"description": ""
},
{"status": "Succeeded",
"id": 2,
"startTime": "2021-11-05T06:00:07.9864525+01:00",
"updateTime": "2021-11-05T06:00:10.377142+01:00",
"title": "Building list of machines to process",
"description": ""
},
{"status": "Succeeded",
"id": 1,
"startTime": "2021-11-05T06:00:07.7051998+01:00",
"updateTime": "2021-11-05T06:00:07.7051998+01:00",
"title": "Job started at 11/5/2021 6:00:02 AM",
"description": ""
}
]
}

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.

SecurityBearer

Request

path Parameters

required

string <uuid>

ID of the session.

header Parameters

x-api-version

required

string

Default: 1.1-rev2

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

Responses

200

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

curl
Python
JavaScript
C#
Go

Response samples

application/json

{ }