Help Center
Choose product document...
Veeam Backup & Replication 9.5
RESTful API Reference

Requests

For requests, the client can use the following standard HTTP methods:

  • POST (Create) — creates a new resource
  • GET (Read) — retrieves information about the resource — the resource representation
  • PUT (Update) — makes changes to a resource
  • DELETE (Delete) — removes a resource

In some cases, the same HTTP method can be used to perform different kinds of actions with the resource. For example, using the POST HTTP method, you can add objects to the job, start a job, stop, retry, clone or disable it. To identify the action that will be performed with the resource, Veeam Backup Enterprise Manager RESTful API adds the name of the action to the end of the action URL, for example:

<Link Rel="Start" Href="http://localhost:9399/api/jobs/568c42ce-eb11-4140-92cf-39ab36712bf5?action=start" />

Additionally, the action is described with the Rel attribute within the link, for example:

<Link Rel="Edit" Type="JobReference" Href="http://localhost:9399/api/jobs/568c42ce-eb11-4140-92cf-39ab36712bf5" Name="Exchange Backup" />

The table below describes relations between the operations that the client can perform with resources and HTTP verbs to be used:

Operation

HTTP Verb

Sample Actions

Create

POST

Create a new resource, for example, a logon session or credentials record.

Delete

DELETE

Delete a resource, for example, a logon session or a task.

Alternate

GET

Get an entity representation or a reference representation for the resource.

Edit

PUT

Edit a resource, for example, a job.

Start

POST

Start some operation, for example, a job.

Stop

POST

Stop some operation, for example, a job.

Retry

POST

Retry some operation, for example, a job.

Clone

POST

Clone a resource, for example, a job.

Related

GET

Get a resource representation of the resource related to the current one, for example, a list of VM restore points related to the catalog VM restore point.

Restore

POST

Perform a restore operation, for example, full VM restore.

Failover

POST

Perform VM replica failover.

Download

POST

Download a file.

ToggleScheduleEnabled

POST

Enable or disable job launch by the schedule.

ToggleRestoreScopesEnabled

POST

Enable or disable restore scope settings for the account having a specific role in Veeam Backup Enterprise Manager.

Browse

POST

Launch the browsing operation for the VM file system.

Up

GET

Retrieve a list of resources that are parent to the current resource, for example: Veeam backup server parent for a job resource.

Down

GET

Retrieve a list of resources that are child to the current resource, for example: job sessions child for a job resource.

Previous

GET

Move back to the previous page with query results

Next

GET

Move forward to the next page with query results

First

GET

Move to the first page with query results

Last

GET

Move to the last page with query results

 

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation