VMware Mirage API Reference Documentation

Welcome to the VMware Mirage API Reference documentation. This API reference provides comprehensive information about all data structures available through the Mirage API:

Connecting to the API

The URL of the API is https://server-address:7443/mirageapi/MitService.svc

Getting started

Before calling into Mirage Api web service, you should generate web service client proxy code.

Here are the steps to generate C# client:

With the generated client, you can log in and call Mirage Api.

ServicePointManager.ServerCertificateValidationCallback = ((sender, certificate, chain, sslPolicyErrors) => true);
BasicHttpBinding binding = new BasicHttpBinding
    AllowCookies = true,
    Security =
        Mode = BasicHttpSecurityMode.Transport

//Connect to Mirage Web Management Server
EndpointAddress endpoint = new EndpointAddress(string.Format("https://server-address:7443/mirageapi/MitService.svc", address));
Client = new MitServiceClient(binding, endpoint);
Client.Login("<username>", "<password>");
Console.WriteLine("Login success!");

//do your work

Navigating the API Reference

The Mirage API Reference is an HTML frameset. Click an entry in the left-hand pane to display information in the right-hand pane. To find the description of a specific object type, click the appropriate category name and then refine your search by entering the object name in the search text field.

To quickly find an entry, start typing its name in the Quick Index field.