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 REST API adds the name of the action to the end of the action URL, for example:
<Link Rel="Start" Href="https://localhost:9398/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="https://localhost:9398/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:
Create a new resource, for example, a logon session or credentials record.
Delete a resource, for example, a logon session or a task.
Get an entity representation or a reference representation for the resource.
Edit a resource, for example, a job.
Start some operation, for example, a job.
Test a cloud failover plan.
Stop some operation, for example, a job.
Retry some operation, for example, a job.
Clone a resource, for example, a job.
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.
Perform a restore operation, for example, entire VM restore.
Perform VM replica failover.
Download a file.
Enable or disable job launch by the schedule.
Enable or disable restore scope settings for the account having a specific role in Veeam Backup Enterprise Manager.
Launch the browsing operation for the VM file system.
Retrieve a list of resources that are parent to the current resource, for example: backup server parent for a job resource.
Retrieve a list of resources that are child to the current resource, for example: job sessions child for a job resource.
Move back to the previous page with query results
Move forward to the next page with query results
Move to the first page with query results
Move to the last page with query results