Veeam Backup & Replication 10
Veeam RESTful API Reference
Related documents

Resource URLs

Every resource and resource collection in Enterprise Manager RESTful API has its own URL. A resource URL functions as a reference to an Enterprise Manager object: it is a resource address that the client can use to access the resource. For example, a Veeam backup server connected to Enterprise Manager can be addressed by the URL of the following type:

https://localhost:9398/api/backupServers/69368052-f7be-4be2-83d7-00ce2bbd7c0a

Every resource URL consists of two parts:

  • Base URL of Veeam Backup Enterprise Manager RESTful API
  • Resource location

Base URL

The base URL is common for all resources: it is the entry point to Veeam Backup Enterprise Manager RESTful API. Veeam Backup Enterprise Manager RESTful API has the following base URL:

https://<Enterprise-Manager>:9398/api/

where:

  • <Enterprise-Manager> is the name of the machine on which Veeam Backup Enterprise Manager is installed.
  • 9398 is an HTTPS port used to communicate with the REST API web service.

In earlier versions of Veeam Backup & Replication, you could also access Veeam Backup Enterprise Manager RESTful API over the HTTP protocol using port 9399. This protocol is deprecated as insecure and is not used in version 1.5 of Veeam Backup Enterprise Manager RESTful API.

Resource Location

The resource location identifies the path to the resource itself in Enterprise Manager RESTful API. The resource location is suffixed to the base URL, forming the URL for the resource. For example, you can access the collection of jobs by the URL of the following type:

https://localhost:9398/api/jobs

The resource location for key resources includes the entity ID. Every key resource has an entity ID — an object identifier in the URN format. The entity ID is unique and persists for the time of the Veeam Backup Enterprise Manager RESTful API work session. For example, a Veeam backup server connected to Veeam Backup Enterprise Manager can have the following entity ID and the following URN:

https://localhost:9398/api/backupServers/21a631e0-af7f-46ba-afbd-273de2e6fd4a

Non-key resources may or may not have IDs that are called resource IDs. For example, the task resource has a resource ID of the following format:

https://localhost:9398/api/tasks/task-1

Such resources as files or directories do not have IDs:

https://localhost:9398/api/vmRestorePoints/e2b02b57-42dd-404a-b8af-8e45a58c1a88/mounts/1/C:/pagefile.sys

 

Resource URLsImportant!

The client must never construct URLs for resources itself. URLs for all resources and actions that the client can perform are generated automatically by the server and provided in resource representations. The client should only select the URL it needs and send a necessary HTTP request to it.

 

This Document Help Center
User Guide for VMware vSphereUser Guide for Microsoft Hyper-VVeeam Backup Enterprise Manager GuideVeeam Agent Management GuideVeeam Cloud Connect GuideVeeam Explorers User GuideVeeam Plug-ins for Enterprise Applications GuideIntegration with Veeam Backup for AWS User GuideVeeam PowerShell ReferenceVeeam Explorers PowerShell ReferenceVeeam RESTful API ReferenceRequired Permissions for VMware vSphereQuick Start Guide for VMware vSphereQuick Start Guide for Microsoft Hyper-VVeeam ONE DocumentationVeeam Agent for Windows DocumentationVeeam Agent for Linux DocumentationVeeam Backup for AWS DocumentationVeeam Backup for Microsoft Azure DocumentationVeeam Backup for Nutanix AHV User GuideVeeam Backup for Microsoft Office 365 DocumentationVeeam Management Pack Documentation
I want to report a typo

There is a misspelling right here:

 

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