GET /query?type=vAppRestorePoint
Returns a resource representation of a collection of vApp restore points created on backup servers that are connected to Veeam Backup Enterprise Manager. For details, see /vAppRestorePoints.
Request
To get a list of vApp restore points, send the GET HTTP request to the query with the type parameter set to vAppRestorePoint.
HTTP Request
|
GET https://<Enterprise-Manager>:9398/api/query?type=vAppRestorePoint |
Request Headers
The request contains the following headers:
|
Header |
Required |
Description |
|---|---|---|
|
X-RestSvcSessionId |
True |
The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security. |
|
Accept |
False |
Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Optional Parameters
In the query, you can use the following parameters for filtering and sorting.
|
Parameter |
Type |
Description |
|---|---|---|
|
UID |
UidType |
UID of the vApp point resource. |
|
Name |
String |
Name of the vApp restore point, for example: vApp02@2025-08-24 05:03:25. |
|
CreationTime |
DateTime |
Date and time when the vApp restore point was created. The parameter accepts only UTC-formatted DateTime values. |
|
Type |
String |
Type of the vApp restore point. Possible values:
|
|
Algorithm |
String |
Backup method used to create the vApp restore point. Possible values:
|
|
RestorePointId |
String |
ID of the vApp restore point. |
|
VAppDisplayName |
String |
Display name of the vApp for which the restore point was created. |
|
BackupServerUid |
UidType |
UID of the backup server on which the vApp restore point has been created. |
|
BackupServerName |
String |
Name of the backup server on which the vApp restore point has been created. |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
|
Header |
Description |
|---|---|
|
Content-length |
The length of the response body. |
|
Content-type |
The media type and syntax of the request body message. Possible values:
|
Response Body
In the response body, the REST API returns a representation of the /vAppRestorePoints resource collection.
Example
The example below returns an entity resource representation of a collection of restore points created for vApp vapp001. The results are ordered in the descending order by the CreationTime parameter.
|
Request: GET https://localhost:9398/api/query?type=VAppRestorePoint&format=Entities&sortDesc=CreationTime&filter=VAppDisplayName=="vapp001-98be6b84-236e-4e25-87fe-b0b47fb64764" Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 OK Response Body: <QueryResult xmlns="http://www.veeam.com/ent/v1.0"> |