GET /catalog/vms
Returns a resource representation of a VM collection whose guest OS files have been indexed during backup.
Supported Platforms
The request is supported for the following platforms:
- VMware vSphere
- Microsoft Hyper-V
Request
To get a list of VMs with indexed guest OS files, send the GET HTTP request to the URL of the /catalog/vms resource.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/catalog/vms |
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.
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 /catalog/vms resource collection.
Example
The example below returns a list of all VMs whose guest OS files have been indexed during backup.
Request: GET https://localhost:9398/api/catalog/vms
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <EntityReferences xmlns="http://www.veeam.com/ent/v1.0"> |