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:
Every resource URL consists of two parts:
- Base URL of Veeam Backup Enterprise Manager RESTful API
- Resource location
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:
- <Enterprise-Manager> is the name of the machine on which Veeam Backup Enterprise Manager is installed.
- 9399 is an HTTP port used to communicate with the REST API web service. You can also access Veeam Backup Enterprise Manager RESTful API over the HTTPS using port 9398.
By default, port 9399 is used. If you have specified another HTTP port during the Enterprise Manager installation, you should adjust the port number in the URL.
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:
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:
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:
Such resources as files or directories do not have IDs:
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.