Veeam Help Center Help Center
Veeam Backup & Replication 13
Veeam Backup Enterprise Manager REST API Reference
Archive
Version 11
Related documents
User Guide User Guide for Microsoft Entra ID Veeam Explorers User Guide Veeam Backup Enterprise Manager Guide Event Reference Veeam PowerShell Reference Veeam Explorers PowerShell Reference REST API Reference Permissions for VMware vSphere Veeam Kasten Integration Guide
Veeam Rental Licensing and Usage Reporting
Search for "" in this document
Search
Veeam Backup & Replication 13
Veeam Backup Enterprise Manager REST API Reference
  • Overview
  • Concepts And Principles
    • Client-Server Model
    • Resources
      • Resource Types
      • Resource URLs
      • Resource Representations
        • Resource Representations for Non-Key Resources
        • Resource Representation for Key Resources
        • Resource Representations for Resource Collections
      • Links
        • Attributes of a Link Element
        • Link Types and XML Schema Definition
        • Mapping Link Types to XML Schema Elements
    • HTTP Requests and Responses
      • Requests
        • POST Method
        • GET Method
        • PUT Method
        • DELETE Method
      • Responses
        • HTTP Response Codes
        • Special Characters in Responses
  • Getting Started
    • Workflow
    • Specifications
    • Versioning
    • Authentication and Security
      • HTTP Authentication
      • TLS Certificate
    • Security Roles
    • Virtual Infrastructure Lookup
      • Lookup Query
      • Constructing HierarchyObjRefType
    • Queries
      • Type Parameter
      • Optional Parameters
        • format
        • sortAsc, sortDesc
        • pageSize, page
        • filter
          • Comparison Expressions
          • Logical Operators: AND, OR
          • Grouping Operators
    • Web Client
    • Beginner Example
      • Step 1. Access Veeam Backup Enterprise Manager REST API
      • Step 2. Perform Logon
      • Step 3. Get a List of Backup Servers
      • Step 4. Perform Logout
  • REST API Reference
    • Logon Sessions
      • /logonSessions
        • GET /logonSessions
        • POST /sessionMngr/
      • /logonSessions/{ID}
        • GET /logonSessions/{ID}
        • DELETE /logonSessions/{ID}
    • Accounts and Roles
      • /security
        • GET /security
      • /security/roles
        • GET /security/roles
      • /security/roles/{ID}
        • GET /security/roles/{ID}
      • /security/accounts
        • GET /security/accounts
        • POST /security/accounts
        • POST /security/accounts?action=rebuildScope
      • /security/accounts/{ID}
        • GET /security/accounts/{ID}
        • POST /security/accounts/{ID}
        • DELETE /security/accounts/{ID}
      • /security/accounts/{ID}/roles
        • GET /security/accounts/{ID}/roles
        • POST /security/accounts/{ID}/roles
      • /security/accounts/{ID}/roles/{ID}
        • GET /security/accounts/{ID}/roles/{ID}
        • DELETE /security/accounts/{ID}/roles/{ID}
      • /security/accounts/{ID}/scopes
        • GET /security/accounts/{ID}/scopes
        • POST /security/accounts/{ID}/scopes
      • /security/accounts/{ID}/scopes/{ID}
        • GET /security/accounts/{ID}/scopes/{ID}
        • DELETE /security/accounts /{ID}/scopes/{ID}
    • Backup Infrastructure
      • /backupServers
        • GET /backupServers
        • POST /backupServers?action=create
      • /backupServers/{ID}
        • GET /backupServers/{ID}
        • PUT /backupServers/{ID}
        • DELETE /backupServers/{ID}
        • POST /backupServers/{ID}?action=veeamzip
        • POST /backupServers/{ID}?action=quickbackup
        • POST /backupServers/{ID}?action=collect
      • /backupServers/{ID}/credentials
        • GET /backupServers/{ID}/credentials
        • POST /backupServers/{ID}/credentials?action=create
      • /backupServers/{ID}/credentials/{ID}
        • GET /backupServers/{ID}/credentials/{ID}
        • PUT /backupServers/{ID}/credentials/{ID}
        • DELETE /backupServers/{ID}/credentials/{ID}
      • /backupServers/{ID}/passwords
        • GET /backupServers/{ID}/passwords
        • POST /backupServers/{ID}/passwords?action=create
      • /backupServers/{ID}/passwords/{ID}
        • GET /backupServers/{ID}/passwords/{ID}
        • PUT /backupServers/{ID}/passwords/{ID}
        • DELETE /backupServers/{ID}/passwords/{ID}
      • /backupServers/{ID}/externalRepositories
        • GET /backupServers/{ID}/externalRepositories
      • /hierarchyRoots
        • GET /hierarchyRoots
      • /hierarchyRoots/{ID}
        • GET /hierarchyRoots/{ID}
      • /managedServers
        • GET /managedServers
      • /managedServers/{ID}
        • GET /managedServers/{ID}
      • /repositories
        • GET /repositories
      • /repositories/{ID}
        • GET /repositories/{ID}
      • /externalRepositories
        • GET /externalRepositories
      • /externalRepositories/{ID}
        • GET /externalRepositories/{ID}
      • /externalRepositories/{ID}/backups
        • GET /externalRepositories/{ID}/backups
      • /wanAccelerators
        • GET /wanAccelerators
      • /wanAccelerators/{ID}
        • GET /wanAccelerators/{ID}
    • Lookup Service
      • /lookupSvc
        • GET /lookupSvc
        • GET /lookup?host={hostUID}&hierarchyRef={hierarchyRef}&name={objName}&type={objType}
    • Jobs
      • /jobs
        • GET /jobs
      • /jobs/{ID}
        • GET /jobs/{ID}
          • Job Scheduling Options
          • Job Info
            • Backup Copy Job Options
          • Simple and GFS Retention Policies
          • Guest Processing Options
        • PUT /jobs/{ID}
        • POST /jobs/{ID}?action=start
        • POST /jobs/{ID}?action=sync
        • POST /jobs/{ID}?action=stop
        • POST /jobs/{ID}?action=retry
        • POST /jobs/{ID}?action=clone
        • POST /jobs/{ID}?action=toggleScheduleEnabled
        • DELETE /jobs/{ID}
      • /jobs/{ID}/includes
        • GET /jobs/{ID}/includes
        • POST /jobs/{ID}/includes
      • /jobs/{ID}/includes/{ID}
        • GET /jobs/{ID}/includes/{ID}
        • DELETE /jobs/{ID}/includes/{ID}
      • /jobs/{ID}/linkedJobs
        • GET /jobs/{ID}/linkedJobs
        • POST /jobs/{ID}/linkedJobs
        • DELETE /jobs/{ID}/linkedJobs/{ID}
      • /jobs/{ID}/linkedBackupRepositories
        • GET /jobs/{ID}/linkedBackupRepositories
        • POST /jobs/{ID}/linkedBackupRepositories
        • DELETE /jobs/{ID}/linkedBackupRepositories/{ID}
    • Backup
      • /backups
        • GET /backups
      • /backups/{ID}
        • GET /backups/{ID}
      • /backups/{ID}/childbackups
        • GET /backups/{ID}/childbackups
      • /backups/{ID}/restorePoints
        • GET /backups/{ID}/restorePoints
      • /backupFiles
        • GET /backupFiles
      • /backupFiles/{ID}
        • GET /backupFiles/{ID}
      • /backupFiles/{ID}/vmRestorePoints
        • GET /backupFiles/{ID}/vmRestorePoints
      • /backupFiles/{ID}/restorePoints
        • GET /backupFiles/{ID}/restorePoints
      • /restorePoints
        • GET /restorePoints
      • /restorePoints/{ID}
        • GET /restorePoints/{ID}
      • /restorePoints/{ID}/backupFiles
        • GET /restorePoints/{ID}/backupFiles
      • /restorePoints/{ID}/vmRestorePoints
        • GET /restorePoints/{ID}/vmRestorePoints
      • /restorePoints/{ID}/vAppRestorePoints
        • GET /restorePoints/{ID}/vAppRestorePoints
      • /restorePoints/{ID}/agentRestorePoints
        • GET /restorePoints/{ID}/agentRestorePoints
      • /vmRestorePoints
        • GET /vmRestorePoints
      • /vmRestorePoints/{ID}
        • GET /vmRestorePoints/{ID}
        • POST /vmRestorePoints/{ID}?action=restore
        • POST /vmRestorePoints/{ID}/mounts
      • /vmRestorePoints/{ID}/mounts
        • GET /vmRestorePoints/{ID}/mounts
      • /vmRestorePoints/{ID}/mounts/{ID}
        • GET /vmRestorePoints/{ID}/mounts/{ID}
        • DELETE /vmRestorePoints/{ID}/mounts/{ID}
      • /vmRestorePoints/{ID}/mounts/{ID}/{filepath}
        • GET /vmRestorePoints/{ID}/mounts/{ID}/{filepath}
        • POST /vmRestorePoints/{ID}/mounts/{ID}/{filepath}?action=restore
      • /vAppRestorePoints
        • GET /vAppRestorePoints
      • /vAppRestorePoints/{ID}
        • GET /vAppRestorePoints/{ID}
        • POST /vAppRestorePoints/{ID}?action=restore
      • /catalog/vms
        • GET /catalog/vms
      • /catalog/vms/{vmname}
        • GET /catalog/vms/{vmname}
      • /catalog/vms/{vmname}/vmRestorePoints
        • GET /catalog/vms/{vmname}/vmRestorePoints
      • /catalog/vms/{vmname}/vmRestorePoints/{ID}
        • GET /catalog/vms/{vmname}/vmRestorePoints/{ID}
        • POST /catalog/vms/{vmname}/vmRestorePoints/{ID}?action=browse
      • /catalog/vms/{vmname}/vmRestorePoints/{ID}/guestfs
        • GET /catalog/vms/{vmname}/vmRestorePoints/{ID}/guestfs
      • /catalog/vms/{vmname}/vmRestorePoints/{ID}/guestfs/{filepath}
        • GET /catalog/vms/{vmname}/vmRestorePoints/{ID}/guestfs/{filepath}
        • POST /catalog/vms/{vmname}/vmRestorePoints/{ID}/guestfs/{filepath}?action=restore
      • /backupSessions
        • GET /backupSessions
      • /backupSessions/{ID}
        • GET /backupSessions/{ID}
        • POST /backupSessions/{ID}?action=stop
      • /backupSessions/{ID}/taskSessions
        • GET /backupSessions/{ID}/taskSessions
      • /backupSessions/{ID}/agentManagementSessions
        • GET /backupSessions/{ID}/agentManagementSessions
      • /backupTaskSessions
        • GET /backupTaskSessions
      • /backupTaskSessions/{ID}
        • GET /backupTaskSessions/{ID}
      • /restoreSessions
        • GET /restoreSessions
      • /restoreSessions/{ID}
        • GET /restoreSessions/{ID}
    • Replication
      • /replicas
        • GET /replicas
      • /replicas/{ID}
        • GET /replicas/{ID}
      • /vmReplicaPoints
        • GET /vmReplicaPoints
      • /vmReplicaPoints/{ID}
        • GET /vmReplicaPoints/{ID}
        • POST /vmReplicaPoints/{ID}?action=failover
        • POST /vmReplicaPoints/{ID}/mounts
      • /vmReplicaPoints/{ID}/mounts
        • GET /vmReplicaPoints/{ID}/mounts
      • /vmReplicaPoints/{ID}/mounts/{ID}
        • GET /vmReplicaPoints/{ID}/mounts/{ID}
        • DELETE /vmReplicaPoints/{ID}/mounts/{ID}
      • /vmReplicaPoints/{ID}/mounts/{ID}/{filepath}
        • GET /vmReplicaPoints/{ID}/mounts/{ID}/{filepath}
        • POST /vmReplicaPoints/{ID}/mounts/{ID}/{filepath}?action=restore
      • /vAppReplicaPoints
        • GET /vAppReplicaPoints
      • /vAppReplicaPoints/{ID}
        • GET /vAppReplicaPoints/{ID}
        • POST /vAppReplicaPoints/{ID}?action=failover
      • /replicaSessions
        • GET /replicaSessions
      • /replicaSessions/{ID}
        • GET /replicaSessions/{ID}
      • /replicaSessions/{ID}/replicaTaskSessions
        • GET /replicaSessions/{ID}/replicaTaskSessions
      • /replicaTaskSessions
        • GET /replicaTaskSessions
      • /replicaTaskSessions/{ID}
        • GET /replicaTaskSessions/{ID}
      • /failoverPlans
        • GET /failoverPlans
      • /failoverPlans/{ID}
        • GET /failoverPlans/{ID}
        • PUT /failoverPlans/{ID}
        • POST /failoverPlans/{ID}?action=start
        • POST /failoverPlans/{ID}?action=undo
    • Continuous Data Protection (CDP)
      • /cdpPolicies
        • GET /cdpPolicies
      • /cdpPolicies/{ID}
        • GET /cdpPolicies/{ID}
          • Policy Scheduling Options
        • PUT /cdpPolicies/{ID}
        • POST /cdpPolicies/{ID}?action=disable
        • POST /cdpPolicies/{ID}&action=enable
      • /cdpPolicies/{ID}/includes
        • GET /cdpPolicies/{ID}/includes
        • POST /cdpPolicies/{ID}/includes
      • /cdpPolicies/{ID}/includes/{ID}
        • GET /cdpPolicies/{ID}/includes/{ID}
          • Guest Processing Options
        • DELETE /cdpPolicies/{ID}/includes/{ID}
      • /cdpPolicies/{ID}/cdpReplicaSessions
        • GET /cdpPolicies/{ID}/cdpReplicaSessions
      • /cdpReplicas
        • GET /cdpReplicas
      • /cdpReplicas/{ID}
        • GET /cdpReplicas/{ID}
      • /cdpReplicas/{ID}/vms
        • GET /cdpReplicas/{ID}/vms
      • /cdpReplicas/{ID}/vms/{ID}
        • GET /cdpReplicas/{ID}/vms/{ID}
        • POST /cdpReplicas/{ID}/vms/{ID}?action=failover
        • POST /cdpReplicas/{ID}/vms/{ID}?action=intervals
      • /cdpReplica/vApps
        • GET /cdpReplica/vApps
      • /cdpReplica/vApps/{ID}
        • GET /cdpReplica/vApps/{ID}
        • POST /cdpReplica/vApps/{ID}?action=failover
        • POST /cdpReplica/vApps/{ID}?action=intervals
      • /cdpReplica/vApps/{ID}/vms
        • GET /cdpReplica/vApps/{ID}/vms
      • /cdpReplica/vApps/{ID}/vms/{ID}
        • GET /cdpReplica/vApps/{ID}/vms/{ID}
      • /cdpReplicaSessions
        • GET /cdpReplicaSessions
      • /cdpReplicaSessions/{ID}
        • GET /cdpReplicaSessions/{ID}
      • /cdpReplicaSessions/{ID}/cdpReplicaTaskSessions
        • GET /cdpReplicaSessions/{ID}/cdpReplicaTaskSessions
      • /cdpReplicaTaskSessions
        • GET /cdpReplicaTaskSessions
      • /cdpReplicaTaskSessions/{ID}
        • GET /cdpReplicaTaskSessions/{ID}
    • NAS Backup
      • /nas
        • GET /nas
      • /nas/jobs
        • GET /nas/jobs
      • /nas/jobs/{ID}
        • GET /nas/jobs/{ID}
        • POST /nas/jobs/{ID}/start
        • POST /nas/jobs/{ID}/stop
        • POST /nas/jobs/{ID}/retry
        • POST /nas/jobs/{ID}/toggleScheduleEnabled
      • /nas/jobs/{ID}/includes
        • GET /nas/jobs/{ID}/includes
      • /nas/jobs/{ID}/includes/{ID}
        • GET /nas/jobs/{ID}/includes/{ID}
      • /nas/jobs/{ID}/backupSessions
        • GET /nas/jobs/{ID}/backupSessions
      • /nas/fileServers
        • GET /nas/fileServers
      • /nas/fileServers/{ID}
        • GET /nas/fileServers/{ID}
      • /nas/backupSessions
        • GET /nas/backupSessions
    • Veeam Agent Management
      • /agents
        • GET /agents
      • /agents/discoveredComputers
        • GET /agents/discoveredComputers
      • /agents/discoveredComputers/{ID}
        • GET /agents/discoveredComputers/{ID}
      • /agents/protectionGroups
        • GET /agents/protectionGroups
      • /agents/protectionGroups/{ID}
        • GET /agents/protectionGroups/{ID}
      • /agents/protectionGroups/{ID}/discoveredComputers
        • GET /agents/protectionGroups/{ID}/discoveredComputers
      • /agents/jobs
        • GET /agents/jobs
      • /agents/jobs/{ID}
        • GET /agents/jobs/{ID}
        • POST /agents/jobs/{ID}?action=start
        • POST /agents/jobs/{ID}?action=stop
        • POST /agents/jobs/{ID}?action=retry
        • POST /agents/jobs/{ID}?action=toggleScheduleEnabled
      • /agents/jobs/{ID}/includes
        • GET /agents/jobs/{ID}/includes
      • /agents/jobs/{ID}/includes/{ID}
        • GET /agents/jobs/{ID}/includes/{ID}
      • /agents/backups
        • GET /agents/backups
      • /agents/backupFiles
        • GET /agents/backupFiles
      • /agents/backupSessions
        • GET /agents/backupSessions
      • /agents/restorePoints
        • GET /agents/restorePoints
      • /agents/agentRestorePoints
        • GET /agents/agentRestorePoints
      • /agents/agentRestorePoints/{ID}
        • GET /agents/agentRestorePoints/{ID}
        • POST /agents/agentRestorePoints/{ID}/mounts
      • /agents/agentRestorePoints/{ID}/mounts
        • GET /agents/agentRestorePoints/{ID}/mounts
      • /agents/agentRestorePoints/{ID}/mounts/{ID}
        • GET /agents/agentRestorePoints/{ID}/mounts/{ID}
        • DELETE /agents/agentRestorePoints/{ID}/mounts/{ID}
      • /agents/agentRestorePoints/{ID}/mounts/{ID}/{filepath}
        • GET /agents/agentRestorePoints/{ID}/mounts/{ID}/{filepath}
        • POST /agents/agentRestorePoints/{ID}/mounts/{ID}/{filepath}?action=restore
    • vCD Organization Configurations
      • /vCloud
        • GET /vCloud
      • /vCloud/orgConfigs
        • GET /vCloud/orgConfigs
        • POST /vCloud/orgConfigs
      • /vCloud/orgConfigs/{ID}
        • GET /vCloud/orgConfigs/{ID}
        • PUT /vCloud/orgConfigs/{ID}
        • POST /vCloud/orgConfigs/{ID}?action=disable
        • DELETE /vCloud/orgConfigs/{ID}
      • /vCloud/orgConfigs/{ID}/backupJobSettings
        • GET /vCloud/orgConfigs/{ID}/backupJobSettings
    • vSphere Self-Service Backup Portal
      • /selfService/vSphere
        • GET /selfService/vSphere
      • /selfService/vSphere/Configs
        • GET /selfService/vSphere/Configs
        • POST /selfService/vSphere/Configs
      • /selfService/vSphere/Configs/{ID}
        • GET /selfService/vSphere/Configs/{ID}
        • PUT /selfService/vSphere/Configs/{ID}
        • DELETE /selfService/vSphere/Configs/{ID}
      • /selfService/vSphere/Configs/{ID}/backupJobSettings
        • GET /selfService/vSphere/Configs/{ID}/backupJobSettings
    • Tasks
      • /tasks
        • GET /tasks
      • /tasks/{ID}
        • GET /tasks/{ID}
        • DELETE /task/{ID}
    • System Sessions
      • /systemSessions
        • GET /systemSessions
      • /systemSessions/{ID}
        • GET /systemSessions/{ID}
      • /systemSessions/{ID}/events
        • GET /systemSessions/{ID}/events
    • Reports
      • /reports/summary
        • GET /reports/summary
      • /reports/summary/overview
        • GET /reports/summary/overview
      • /reports/summary/vms_overview
        • GET /reports/summary/vms_overview
      • /reports/summary/job_statistics
        • GET /reports/summary/job_statistics
      • /reports/summary/processed_vms
        • GET /reports/summary/processed_vms
      • /reports/summary/repository
        • GET /reports/summary/repository
    • Query Service
      • /querySvc
        • GET /querySvc
        • GET /query?type=AgentBackupJob
        • GET /query?type=AgentProtectionGroup
        • GET /query?type=AgentRestorePoint
        • GET /query?type=Backup
        • GET /query?type=BackupFile
        • GET /query?type=BackupJobSession
        • GET /query?type=BackupServer
        • GET /query?type=BackupTaskSession
        • GET /query?type=CdpPolicy
        • GET /query?type=CdpReplica
        • GET /query?type=CdpReplicaSession
        • GET /query?type=CdpReplicaTaskSession
        • GET /query?type=Credentials
        • GET /query?type=DiscoveredComputer
        • GET /query?type=FailoverPlan
        • GET /query?type=FileServer
        • GET /query?type=HierarchyRoot
        • GET /query?type=Job
        • GET /query?type=ManagedServer
        • GET /query?type=NasJob
        • GET /query?type=NasObject
        • GET /query?type=ObjectInAgentBackupJob
        • GET /query?type=ObjectInJob
        • GET /query?type=Passwords
        • GET /query?type=Replica
        • GET /query?type=ReplicaJobSession
        • GET /query?type=ReplicaTaskSession
        • GET /query?type=Repository
        • GET /query?type=RestorePoint
        • GET /query?type=RestoreSession
        • GET /query?type=Task
        • GET /query?type=vAppReplicaPoint
        • GET /query?type=vAppRestorePoint
        • GET /query?type=VCloudOrganizationConfig
        • GET /query?type=VmReplicaPoint
        • GET /query?type=VmRestorePoint
        • GET /query?type=VsphereSelfServiceConfig
        • GET /query?type=WanAccelerator
  • Sample Scenarios
    • Starting Job
    • Performing 1-Click Restore
    • Performing Entire VM Restore
    • Assigning Restore Scope
  • REST API 1.7 Changelog
    • Global Changes
    • Breaking Changes
    • New Operations
    • Resource Changes
>Veeam Backup Enterprise Manager REST API Reference>REST API Reference>Backup

Backup

In this article

    This section contains resources and methods for managing backups created on backup servers connected to Veeam Backup Enterprise Manager.

    In this section

    • /backups
    • /backups/{ID}
    • /backups/{ID}/childbackups
    • /backups/{ID}/restorePoints
    • /backupFiles
    • /backupFiles/{ID}
    • /backupFiles/{ID}/vmRestorePoints
    • /backupFiles/{ID}/restorePoints
    • /restorePoints
    • /restorePoints/{ID}
    • /restorePoints/{ID}/backupFiles
    • /restorePoints/{ID}/vmRestorePoints
    • /restorePoints/{ID}/vAppRestorePoints
    • /restorePoints/{ID}/agentRestorePoints
    • /vmRestorePoints
    • /vmRestorePoints/{ID}
    • /vmRestorePoints/{ID}/mounts
    • /vmRestorePoints/{ID}/mounts/{ID}
    • /vmRestorePoints/{ID}/mounts/{ID}/{filepath}
    • /vAppRestorePoints
    • /vAppRestorePoints/{ID}
    • /catalog/vms
    • /catalog/vms/{vmname}
    • /catalog/vms/{vmname}/vmRestorePoints
    • /catalog/vms/{vmname}/vmRestorePoints/{ID}
    • /catalog/vms/{vmname}/vmRestorePoints/{ID}/guestfs/
    • /catalog/vms/{vmname}/vmRestorePoints/{ID}/guestfs/{filepath}
    • /backupSessions
    • /backupSessions/{ID}
    • /backupSessions/{ID}/taskSessions
    • /backupSessions/{ID}/agentManagementSessions
    • /backupTaskSessions
    • /backupTaskSessions/{ID}
    • /restoreSessions
    • /restoreSessions/{ID}

    Page updated 5/22/2025

    Page content applies to build 13.0.0.4967

    Send feedback
    Home | Products | Forums | Support | Contact Sales | EULA

    © Veeam® Software Privacy Notice | Veeam Uses AI | Cookie Notice

    View all results across Veeam Help Center
    Back to document search
    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.

    Submit report