This is an archive version of the document. To get the most up-to-date information, see the current version.

(GET) /catalog/vms/{vmname}

On This Page

Returns a resource representation of a VM having the specified name whose guest OS files have been indexed during backup.

Request

To get a VM with indexed guest OS files, you need to send the GET HTTP request to the URL of the/catalog/vms/{vmname} resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/api/catalog/vms/{vmname}

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. To learn more, see Authentication and Security.

Request Body

None.

Query Parameters

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 200 Success.

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: application/xml.

Response Body

In the response body, Veeam Backup Enterprise Manager returns a representation of the /catalog/vms/{vmname} resource.

Example

The example below returns a representation of the srv04 VM. The VM guest OS files have been indexed during backup.

Request:

GET http://localhost:9399/api/catalog/vms/srv04

Request Header:

X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

Response:

200 Success

Response Body: