Resource URLs

Each Veeam ONE REST API-exposed entity has a resource representing it. To get a resource representation, request its URL. Most of Veeam ONE REST API URLs have the following base:

where:

  • <hostname> is the DNS name or IP address of the machine on which the Veeam ONE Web Services component is installed.
  • <port> is the REST API port number you specified during the Veeam ONE Web Services component installation.

The default port number is 1239.

  • <version> is an API version.

To get a collection of Veeam ONE REST API resources, request a base URL followed by resource collection path. For example:

https://one-srv:1239/api/v2.2/sessions

To get a representation of an individual resource, enter a resource identifier after a resource collection path. For example:

https://one-srv:1239/api/v2.2/sessions/1000

In the following example, the resource identifier is represented by the jobSessionId property of the resource from the collection.

{

 "jobSessionId": 1000,

 "name": "Object properties data collection",

 "type": "AggregateProperties",

 "status": "Success",

 "statusPriority": 0,

 "start": "2023-11-15T12:32:02.7Z",

 "end": "2023-11-15T12:32:02.7Z"

}

Page updated 12/1/2023

Page content applies to build 12.3.0.4670