Veeam Backup & Replication
App · 23 actions
Keep an eye on Veeam Backup & Replication from workflows: list jobs and their last results, start, stop, retry, enable and disable jobs, read sessions and their logs, backups, restore points, repositories' free space and malware events. Start a workflow when a job finishes or fails, a restore point is made, malware is found or a repository runs low on space.
Actions
| Action | What it does |
|---|---|
| Disable job | Turn a job off so it doesn't run on its schedule, such as during maintenance. |
| Enable job | Turn a disabled job back on, so it runs on its schedule again. |
| Get backup | Read a backup: the job that made it, its platform, when it was first made and the repository it is stored in. |
| Get job | Read a job: its status, last result, last and next run, whether it's disabled, and its settings (what it backs up, storage and schedule). |
| Get restore point | Read a restore point: the machine, when it was made, full or incremental, its malware status and the restores it allows. |
| Get server info | Read the backup server's name, Veeam Backup & Replication build, installed patches and database, which also checks the connection works. |
| Get session | Read a session: its state, progress, result and Veeam's message about it, such as to wait for a job started by 'Start job'. |
| Get session log | Read a session's log, the lines the console shows for a run, or only its warnings and errors, such as to post why a job failed. |
| List backups | List backups, newest first, by job, name and when they were made, with the repository each is stored in. |
| List credentials | List the credentials records Veeam keeps for reaching servers, by account name and description. |
| List jobs | List backup and replication jobs with their status, last result, last and next run and repository, such as to report the ones that failed. |
| List machines in backup | List the machines and other objects a backup holds, with how many restore points each has. |
| List malware events | List what Veeam's malware detection found, newest first: encrypted data, ransomware notes, suspicious files and antivirus findings, by severity, kind, state and date. |
| List managed servers | List the servers Veeam manages (vCenter and ESXi hosts, Windows and Linux servers) and whether each is available. |
| List proxies | List the backup proxies that move data during backups, with their settings. |
| List repositories | List backup repositories with their size, free space (also as a percentage) and whether they are online. |
| List restore points | List restore points, newest first, by backup, machine, name, malware status and date, such as to check a machine was backed up last night. |
| List session machines | List the machines or objects a session processed, with each one's result and message, such as to name the machines a job failed on. |
| List sessions | List job runs, restores and other sessions, newest first, by job, result, state, kind and when they started or ended. |
| Retry job | Run a job again for only the machines that failed in its last run, as Retry does in the console. |
| Start job | Run a job now, outside its schedule, optionally as an active full backup. |
| Stop job | Stop a job that is running, at once or after the machines it is working on are done. |
| Stop session | Stop a running session, such as a restore or a job run. |
Disable job
Turn a job off so it doesn't run on its schedule, such as during maintenance. It keeps its settings and backups.
Inputs
- Job
jobtextRequired - The job, chosen from the list, or its exact name or ID.
Outputs
disabledtrue/false- True if the job is now disabled
job_idtext- The job's ID
nametext- The job's name
statustext- The job's status as Veeam now reports it
Example output
{
"disabled": true,
"job_id": "e35ef047-8cfa-4c3e-979e-de2e5399142f",
"name": "Nightly VM backup",
"status": "Disabled"
}Enable job
Turn a disabled job back on, so it runs on its schedule again.
Inputs
- Job
jobtextRequired - The job, chosen from the list, or its exact name or ID.
Outputs
disabledtrue/false- True if the job is now disabled
job_idtext- The job's ID
nametext- The job's name
statustext- The job's status as Veeam now reports it
Example output
{
"disabled": false,
"job_id": "e35ef047-8cfa-4c3e-979e-de2e5399142f",
"name": "Nightly VM backup",
"status": "Stopped"
}Get backup
Read a backup: the job that made it, its platform, when it was first made and the repository it is stored in.
Inputs
- Backup
backuptextRequired - The backup, chosen from the list, or its ID from an earlier step.
Outputs
backupobject- The backup
Example output
{
"backup": {
"creationTime": "2026-07-09T10:58:28+00:00",
"id": "5a39b6d1-008c-4518-bb08-869221b61235",
"jobId": "e35ef047-8cfa-4c3e-979e-de2e5399142f",
"name": "Nightly VM backup",
"platformId": "00000000-0000-0000-0000-000000000000",
"platformName": "VMware",
"policyUniqueId": "e35ef047-8cfa-4c3e-979e-de2e5399142f",
"repositoryId": "d4b5e196-f3ad-474c-99bc-dfef051dae07"
}
}Get job
Read a job: its status, last result, last and next run, whether it's disabled, and its settings (what it backs up, storage and schedule).
Inputs
- Job
jobtextRequired - The job, chosen from the list, or its exact name or ID.
Outputs
jobobject- The job's state
settingsobject- The job's settings as Veeam gives them: what it backs up, its storage, schedule and retention. Empty for a kind of job the settings call doesn't cover.
Example output
{
"job": {
"description": "Created by CORP\\veeamadmin.",
"id": "e35ef047-8cfa-4c3e-979e-de2e5399142f",
"isDisabled": false,
"lastResult": "Success",
"lastRun": "2026-11-11T22:00:12+00:00",
"name": "Nightly VM backup",
"nextRun": "2026-11-12T22:00:00+00:00",
"objectsCount": 12,
"repositoryId": "d4b5e196-f3ad-474c-99bc-dfef051dae07",
"repositoryName": "Backup Repository 1",
"sessionId": "6c76bb17-8695-4f7c-981f-670789edd8f3",
"status": "Stopped",
"type": "VSphereBackup",
"workload": "Vm"
},
"settings": {
"id": "e35ef047-8cfa-4c3e-979e-de2e5399142f",
"isDisabled": false,
"name": "Nightly VM backup",
"schedule": {
"runAutomatically": true
},
"storage": {
"backupRepositoryId": "d4b5e196-f3ad-474c-99bc-dfef051dae07"
},
"type": "VSphereBackup"
}
}Get restore point
Read a restore point: the machine, when it was made, full or incremental, its malware status and the restores it allows.
Inputs
- Restore point ID
restore_pointtextRequired - The restore point's ID, from a trigger or 'List restore points'.
Outputs
restore_pointobject- The restore point
Example output
{
"restore_point": {
"allowedOperations": [
"StartViVMInstantRecovery",
"StartFlrRestore"
],
"backupFileId": "bfe4ce8a-a41e-4a86-aae6-1471fac1bb31",
"backupId": "5a39b6d1-008c-4518-bb08-869221b61235",
"creationTime": "2026-11-11T22:03:08+00:00",
"id": "56a6e3ac-2771-4fcc-8b8c-0632c708d94f",
"malwareStatus": "Clean",
"name": "dbserver01",
"platformId": "00000000-0000-0000-0000-000000000000",
"platformName": "VMware",
"sessionId": "b1380736-18a9-4fac-adfe-20abc570e8de",
"type": "Increment"
}
}Get server info
Read the backup server's name, Veeam Backup & Replication build, installed patches and database, which also checks the connection works.
Inputs
None.
Outputs
api_revisiontext- The REST API revision the server answered with, such as 1.3-rev1
serverobject- The backup server
Example output
{
"api_revision": "1.3-rev1",
"server": {
"buildVersion": "13.0.1.180",
"databaseContentVersion": "9688",
"databaseSchemaVersion": "9688",
"databaseVendor": "PostgreSQL",
"name": "backup01.corp.example.com",
"patches": [],
"sqlServerEdition": "",
"sqlServerVersion": "PostgreSQL 17.5",
"vbrId": "f2ef2bfd-e8e6-418a-8725-472e2e2d1efc"
}
}Get session
Read a session: its state, progress, result and Veeam's message about it, such as to wait for a job started by 'Start job'.
Inputs
- Session ID
sessiontextRequired - The session's ID, from a trigger or an earlier step such as 'Start job' or 'List sessions'.
Outputs
sessionobject- The session
Example output
{
"session": {
"creationTime": "2026-11-11T22:00:12+00:00",
"endTime": "2026-11-11T22:26:16+00:00",
"id": "b1380736-18a9-4fac-adfe-20abc570e8de",
"jobId": "e35ef047-8cfa-4c3e-979e-de2e5399142f",
"name": "Nightly VM backup",
"parentSessionId": "",
"platformId": "00000000-0000-0000-0000-000000000000",
"platformName": "VMware",
"progressPercent": 100,
"resourceId": "5a39b6d1-008c-4518-bb08-869221b61235",
"resourceReference": "/api/v1/backups/5a39b6d1-008c-4518-bb08-869221b61235",
"result": {
"isCanceled": false,
"message": "",
"result": "Success"
},
"sessionType": "BackupJob",
"state": "Stopped",
"usn": 52811
}
}Get session log
Read a session's log, the lines the console shows for a run, or only its warnings and errors, such as to post why a job failed.
Inputs
- Session ID
sessiontextRequired - The session's ID, from a trigger or an earlier step such as 'Start job' or 'List sessions'.
- Only warnings and errors
only_problemstrue/false - List only the lines with a warning or an error.Default:
false.
Outputs
countnumber- How many lines are listed
recordslist- The log's lines, in the order they were written
session_idtext- The session's ID
totalnumber- How many lines the log has in all
Example output
{
"count": 1,
"records": [
{
"description": "",
"id": 7,
"startTime": "2026-11-11T22:00:24+00:00",
"status": "Warning",
"title": "Processing dbserver01: Changed block tracking cannot be enabled",
"updateTime": "2026-11-11T22:03:08+00:00"
}
],
"session_id": "b1380736-18a9-4fac-adfe-20abc570e8de",
"total": 11
}List backups
List backups, newest first, by job, name and when they were made, with the repository each is stored in.
Inputs
- Job
jobtext - Only the backups this job made.
- Name contains
nametext - Only those whose name contains these words.
- Made after
created_afterdate and time - Only backups first made after this.
- Made before
created_beforedate and time - Only backups first made before this.
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 500.
- Skip
skipnumber - How many to skip, to read the next page: the number listed so far.At least 0.
Outputs
backupslist- The backups, newest first
countnumber- How many are on this page
has_moretrue/false- True if there are more after this page: run it again with Skip
skipnumber- How many were skipped before this page
totalnumber- How many match in all
Example output
{
"backups": [
{
"creationTime": "2026-07-09T10:58:28+00:00",
"id": "5a39b6d1-008c-4518-bb08-869221b61235",
"jobId": "e35ef047-8cfa-4c3e-979e-de2e5399142f",
"name": "Nightly VM backup",
"platformId": "00000000-0000-0000-0000-000000000000",
"platformName": "VMware",
"policyUniqueId": "e35ef047-8cfa-4c3e-979e-de2e5399142f",
"repositoryId": "d4b5e196-f3ad-474c-99bc-dfef051dae07"
}
],
"count": 1,
"has_more": false,
"skip": 0,
"total": 1
}List credentials
List the credentials records Veeam keeps for reaching servers, by account name and description. Passwords and keys are never read.
Inputs
- Name contains
nametext - Only those whose name contains these words.
- Kind
credential_typetext - Only records of this kind.One of:
Standard(Standard (Windows)),Linux. - How many
limitnumber - The most to list. Defaults to 50.From 1 to 500.
- Skip
skipnumber - How many to skip, to read the next page: the number listed so far.At least 0.
Outputs
countnumber- How many are on this page
credentialslist- The credentials records, by account name; never a password
has_moretrue/false- True if there are more after this page: run it again with Skip
skipnumber- How many were skipped before this page
totalnumber- How many match in all
Example output
{
"count": 1,
"credentials": [
{
"creationTime": "2026-03-02T09:12:44+00:00",
"description": "Guest processing on Windows servers",
"id": "b860489e-490d-4e43-b20a-a91c4e7d2e76",
"type": "Standard",
"username": "CORP\\svc-backup"
}
],
"has_more": false,
"skip": 0,
"total": 1
}List jobs
List backup and replication jobs with their status, last result, last and next run and repository, such as to report the ones that failed.
Inputs
- Name contains
nametext - Only those whose name contains these words.
- Last result
last_resulttext - Only jobs whose last run finished this way.One of:
Success,Warning,Failed,None(Not finished). - Repository
repositorytext - Only jobs that back up to this repository.
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 500.
- Skip
skipnumber - How many to skip, to read the next page: the number listed so far.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- True if there are more after this page: run it again with Skip
jobslist- The jobs, by name, with their last result
skipnumber- How many were skipped before this page
totalnumber- How many match in all
Example output
{
"count": 1,
"has_more": false,
"jobs": [
{
"description": "Created by CORP\\veeamadmin.",
"id": "e35ef047-8cfa-4c3e-979e-de2e5399142f",
"lastResult": "Success",
"lastRun": "2026-11-11T22:00:12+00:00",
"name": "Nightly VM backup",
"nextRun": "2026-11-12T22:00:00+00:00",
"objectsCount": 12,
"repositoryId": "d4b5e196-f3ad-474c-99bc-dfef051dae07",
"repositoryName": "Backup Repository 1",
"sessionId": "6c76bb17-8695-4f7c-981f-670789edd8f3",
"status": "Stopped",
"type": "VSphereBackup",
"workload": "Vm"
}
],
"skip": 0,
"total": 1
}List machines in backup
List the machines and other objects a backup holds, with how many restore points each has.
Inputs
- Backup
backuptextRequired - The backup, chosen from the list, or its ID from an earlier step.
Outputs
backup_idtext- The backup's ID
countnumber- How many there are
objectslist- The machines and other objects in the backup
Example output
{
"backup_id": "5a39b6d1-008c-4518-bb08-869221b61235",
"count": 1,
"objects": [
{
"id": "fcea73fa-aa48-45e1-89e4-6e33411e8de2",
"name": "dbserver01",
"platformId": "00000000-0000-0000-0000-000000000000",
"platformName": "VMware",
"restorePointsCount": 13,
"type": "VM"
}
]
}List malware events
List what Veeam's malware detection found, newest first: encrypted data, ransomware notes, suspicious files and antivirus findings, by severity, kind, state and date.
Inputs
- Severity
severitytext - Only events this severe.One of:
Infected,Suspicious,Clean. - Kind
event_typetext - Only events of this kind.One of:
EncryptedData(Encrypted data),RansomwareNotes(Ransomware notes),MalwareExtensions(Malware file extensions),DeletedUsefulFiles(Deleted useful files),RenamedFiles(Renamed files),IndicatorOfCompromise(Indicator of compromise),AntivirusScan(Antivirus scan),YaraScan(YARA scan),Unknown. - State
statetext - Only events in this state.One of:
Created(Open),FalsePositive(Marked as false positive). - Reported by
sourcetext - Only events reported this way.One of:
InternalVeeamDetector(Veeam's own detection),External(An outside tool),Manual(Marked by hand),MarkAsCleanEvent(Marked as clean). - Found after
detected_afterdate and time - Only events found after this.
- Found before
detected_beforedate and time - Only events found before this.
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 500.
- Skip
skipnumber - How many to skip, to read the next page: the number listed so far.At least 0.
Outputs
countnumber- How many are on this page
eventslist- The malware events, newest first
has_moretrue/false- True if there are more after this page: run it again with Skip
skipnumber- How many were skipped before this page
totalnumber- How many match in all
Example output
{
"count": 1,
"events": [
{
"createdBy": "Veeam Backup & Replication",
"details": "Potential malware activity detected: data encryption.",
"detectionTimeUtc": "2026-11-11T22:05:31Z",
"engine": "Inline scan",
"id": "0b6c5f61-1a0e-4b2e-9a1f-8f4f3c2d1e00",
"machine": {
"backupObjectId": "fcea73fa-aa48-45e1-89e4-6e33411e8de2",
"displayName": "fileserver02",
"uuid": "4237c0de-1f2a-9c3e-77a1-0d8e6b5a4c21"
},
"severity": "Suspicious",
"source": "InternalVeeamDetector",
"state": "Created",
"type": "EncryptedData"
}
],
"has_more": false,
"skip": 0,
"total": 1
}List managed servers
List the servers Veeam manages (vCenter and ESXi hosts, Windows and Linux servers) and whether each is available.
Inputs
- Name contains
nametext - Only those whose name contains these words.
- Kind
server_typetext - Only servers of this kind.One of:
ViHost(VMware vSphere (vCenter or ESXi)),WindowsHost(Microsoft Windows),LinuxHost(Linux),CloudDirectorHost(VMware Cloud Director). - How many
limitnumber - The most to list. Defaults to 50.From 1 to 500.
- Skip
skipnumber - How many to skip, to read the next page: the number listed so far.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- True if there are more after this page: run it again with Skip
serverslist- The servers, by name
skipnumber- How many were skipped before this page
totalnumber- How many match in all
Example output
{
"count": 1,
"has_more": false,
"servers": [
{
"description": "Created by CORP\\veeamadmin",
"id": "535b5414-788d-4720-a53a-ecc830d2589b",
"name": "vcenter01.corp.example.com",
"status": "Available",
"type": "ViHost"
}
],
"skip": 0,
"total": 1
}List proxies
List the backup proxies that move data during backups, with their settings.
Inputs
- Name contains
nametext - Only those whose name contains these words.
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 500.
- Skip
skipnumber - How many to skip, to read the next page: the number listed so far.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- True if there are more after this page: run it again with Skip
proxieslist- The backup proxies, by name
skipnumber- How many were skipped before this page
totalnumber- How many match in all
Example output
{
"count": 1,
"has_more": false,
"proxies": [
{
"description": "Created by CORP\\veeamadmin",
"id": "18b661c1-d9dc-4233-90a0-7e7b10dc2d09",
"name": "VMware Backup Proxy",
"server": {
"hostId": "6745a759-2205-4cd2-b172-8ec8f7e60ef8",
"maxTaskCount": 4,
"transportMode": "auto"
},
"type": "ViProxy"
}
],
"skip": 0,
"total": 1
}List repositories
List backup repositories with their size, free space (also as a percentage) and whether they are online.
Inputs
- Name contains
nametext - Only those whose name contains these words.
- Only online
online_onlytrue/false - List only the repositories Veeam can reach.Default:
false. - How many
limitnumber - The most to list. Defaults to 50.From 1 to 500.
- Skip
skipnumber - How many to skip, to read the next page: the number listed so far.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- True if there are more after this page: run it again with Skip
repositorieslist- The repositories, by name, with their free space
skipnumber- How many were skipped before this page
totalnumber- How many match in all
Example output
{
"count": 1,
"has_more": false,
"repositories": [
{
"capacityGB": 2048.0,
"description": "Created by CORP\\veeamadmin",
"freeGB": 153.6,
"freePercent": 7.5,
"hostId": "e22b8842-c454-4036-abd5-f468c3248aaf",
"hostName": "repo01.corp.example.com",
"id": "d4b5e196-f3ad-474c-99bc-dfef051dae07",
"isOnline": true,
"name": "Backup Repository 1",
"path": "C:\\Backup Repository",
"type": "WinLocal",
"usedSpaceGB": 1894.4
}
],
"skip": 0,
"total": 1
}List restore points
List restore points, newest first, by backup, machine, name, malware status and date, such as to check a machine was backed up last night.
Inputs
- Backup
backuptext - Only restore points in this backup.
- Machine ID
backup_objecttext - Only this machine's restore points: its ID from 'List machines in backup' or a malware event.
- Name contains
nametext - Only those whose name contains these words.
- Malware status
malware_statustext - Only restore points malware detection marked this way.One of:
Infected,Suspicious,Clean. - Made after
created_afterdate and time - Only restore points made after this.
- Made before
created_beforedate and time - Only restore points made before this.
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 500.
- Skip
skipnumber - How many to skip, to read the next page: the number listed so far.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- True if there are more after this page: run it again with Skip
restore_pointslist- The restore points, newest first
skipnumber- How many were skipped before this page
totalnumber- How many match in all
Example output
{
"count": 1,
"has_more": false,
"restore_points": [
{
"allowedOperations": [
"StartViVMInstantRecovery",
"StartFlrRestore"
],
"backupFileId": "bfe4ce8a-a41e-4a86-aae6-1471fac1bb31",
"backupId": "5a39b6d1-008c-4518-bb08-869221b61235",
"creationTime": "2026-11-11T22:03:08+00:00",
"id": "56a6e3ac-2771-4fcc-8b8c-0632c708d94f",
"malwareStatus": "Clean",
"name": "dbserver01",
"platformId": "00000000-0000-0000-0000-000000000000",
"platformName": "VMware",
"sessionId": "b1380736-18a9-4fac-adfe-20abc570e8de",
"type": "Increment"
}
],
"skip": 0,
"total": 1
}List session machines
List the machines or objects a session processed, with each one's result and message, such as to name the machines a job failed on.
Inputs
- Session ID
sessiontextRequired - The session's ID, from a trigger or an earlier step such as 'Start job' or 'List sessions'.
Outputs
countnumber- How many tasks there are
session_idtext- The session's ID
taskslist- One task per machine or object the session processed
Example output
{
"count": 1,
"session_id": "b1380736-18a9-4fac-adfe-20abc570e8de",
"tasks": [
{
"algorithm": "Increment",
"creationTime": "2026-11-11T22:00:24+00:00",
"endTime": "2026-11-11T22:03:08+00:00",
"id": "3464ca27-8def-4849-a69f-23f0d0d136e7",
"name": "dbserver01",
"repositoryId": "d4b5e196-f3ad-474c-99bc-dfef051dae07",
"restorePointId": "56a6e3ac-2771-4fcc-8b8c-0632c708d94f",
"result": {
"isCanceled": false,
"message": "Changed block tracking cannot be enabled",
"result": "Warning"
},
"sessionId": "b1380736-18a9-4fac-adfe-20abc570e8de",
"sessionType": "BackupJob",
"state": "Stopped",
"type": "Backup",
"usn": 52809
}
]
}List sessions
List job runs, restores and other sessions, newest first, by job, result, state, kind and when they started or ended.
Inputs
- Job
jobtext - Only this job's sessions.
- Result
resulttext - Only sessions that finished this way.One of:
Success,Warning,Failed,None(Not finished). - State
statetext - Only sessions in this state.One of:
Working,Stopped(Finished (stopped)),Starting,Stopping,Postprocessing,Idle,WaitingRepository(Waiting for a repository),WaitingSlot(Waiting for a slot),WaitingTape(Waiting for a tape). - Kind
session_typetext - Only sessions of this kind.One of:
BackupJob(Backup job),ReplicaJob(Replication job),SureBackup(SureBackup job),ConfigurationBackup(Configuration backup),RestoreVm(Entire VM restore),InstantRecovery(Instant Recovery),FileLevelRestore(File-level restore (Windows)),LinuxFileLevelRestore(File-level restore (Linux)),MalwareDetection(Malware scan),Infrastructure. - Started after
created_afterdate and time - Only sessions started after this.
- Started before
created_beforedate and time - Only sessions started before this.
- Ended after
ended_afterdate and time - Only sessions that ended after this.
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 500.
- Skip
skipnumber - How many to skip, to read the next page: the number listed so far.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- True if there are more after this page: run it again with Skip
sessionslist- The sessions, newest first
skipnumber- How many were skipped before this page
totalnumber- How many match in all
Example output
{
"count": 1,
"has_more": false,
"sessions": [
{
"creationTime": "2026-11-11T22:00:12+00:00",
"endTime": "2026-11-11T22:26:16+00:00",
"id": "b1380736-18a9-4fac-adfe-20abc570e8de",
"jobId": "e35ef047-8cfa-4c3e-979e-de2e5399142f",
"name": "Nightly VM backup",
"parentSessionId": "",
"platformId": "00000000-0000-0000-0000-000000000000",
"platformName": "VMware",
"progressPercent": 100,
"resourceId": "5a39b6d1-008c-4518-bb08-869221b61235",
"resourceReference": "/api/v1/backups/5a39b6d1-008c-4518-bb08-869221b61235",
"result": {
"isCanceled": false,
"message": "",
"result": "Success"
},
"sessionType": "BackupJob",
"state": "Stopped",
"usn": 52811
}
],
"skip": 0,
"total": 1
}Retry job
Run a job again for only the machines that failed in its last run, as Retry does in the console. Needs Veeam Backup & Replication 13.0.1 or later.
Inputs
- Job
jobtextRequired - The job, chosen from the list, or its exact name or ID.
- Start chained jobs
start_chained_jobstrue/false - Also start the jobs set to run after this one. Leave off to run only this job.
Outputs
sessionobject- The job's new session
Example output
{
"session": {
"creationTime": "2026-11-12T09:15:02+00:00",
"endTime": "",
"id": "1f5c2b0e-6a1d-4c4e-9a54-6b9a1f0a7d21",
"jobId": "e35ef047-8cfa-4c3e-979e-de2e5399142f",
"name": "Nightly VM backup",
"parentSessionId": "",
"platformId": "00000000-0000-0000-0000-000000000000",
"platformName": "VMware",
"progressPercent": 0,
"resourceId": "5a39b6d1-008c-4518-bb08-869221b61235",
"resourceReference": "/api/v1/backups/5a39b6d1-008c-4518-bb08-869221b61235",
"result": {
"isCanceled": false,
"message": "",
"result": "None"
},
"sessionType": "BackupJob",
"state": "Starting",
"usn": 52811
}
}Start job
Run a job now, outside its schedule, optionally as an active full backup. Gives the new session, to follow with 'Get session'.
Inputs
- Job
jobtextRequired - The job, chosen from the list, or its exact name or ID.
- Active full backup
active_fulltrue/false - Make a new full backup instead of an incremental one. Takes longer and uses more space.Default:
false. - Start chained jobs
start_chained_jobstrue/false - Also start the jobs set to run after this one. Leave off to run only this job.
Outputs
sessionobject- The job's new session
Example output
{
"session": {
"creationTime": "2026-11-12T09:15:02+00:00",
"endTime": "",
"id": "1f5c2b0e-6a1d-4c4e-9a54-6b9a1f0a7d21",
"jobId": "e35ef047-8cfa-4c3e-979e-de2e5399142f",
"name": "Nightly VM backup",
"parentSessionId": "",
"platformId": "00000000-0000-0000-0000-000000000000",
"platformName": "VMware",
"progressPercent": 0,
"resourceId": "5a39b6d1-008c-4518-bb08-869221b61235",
"resourceReference": "/api/v1/backups/5a39b6d1-008c-4518-bb08-869221b61235",
"result": {
"isCanceled": false,
"message": "",
"result": "None"
},
"sessionType": "BackupJob",
"state": "Starting",
"usn": 52811
}
}Stop job
Stop a job that is running, at once or after the machines it is working on are done.
Inputs
- Job
jobtextRequired - The job, chosen from the list, or its exact name or ID.
- Finish current machines first
gracefultrue/false - Let the job finish the machines it has started, so they get a new restore point, before it stops. Off stops it at once.Default:
false.
Outputs
sessionobject- The job's new session
Example output
{
"session": {
"creationTime": "2026-11-12T09:15:02+00:00",
"endTime": "",
"id": "1f5c2b0e-6a1d-4c4e-9a54-6b9a1f0a7d21",
"jobId": "e35ef047-8cfa-4c3e-979e-de2e5399142f",
"name": "Nightly VM backup",
"parentSessionId": "",
"platformId": "00000000-0000-0000-0000-000000000000",
"platformName": "VMware",
"progressPercent": 0,
"resourceId": "5a39b6d1-008c-4518-bb08-869221b61235",
"resourceReference": "/api/v1/backups/5a39b6d1-008c-4518-bb08-869221b61235",
"result": {
"isCanceled": false,
"message": "",
"result": "None"
},
"sessionType": "BackupJob",
"state": "Starting",
"usn": 52811
}
}Stop session
Stop a running session, such as a restore or a job run. 'Get session' then shows when it has stopped.
Inputs
- Session ID
sessiontextRequired - The session's ID, from a trigger or an earlier step such as 'Start job' or 'List sessions'.
Outputs
session_idtext- The session's ID
stop_requestedtrue/false- True: Veeam was asked to stop it. 'Get session' shows when it has.
Example output
{
"session_id": "1f5c2b0e-6a1d-4c4e-9a54-6b9a1f0a7d21",
"stop_requested": true
}