Getting Started With the CloudM Migrate API

The CloudM Migrate API allows third party applications (usually developed by you as the customer) to communicate with CloudM Migrate. This allows you to automate and run migration processes from your own application, without requiring you to log in to the CloudM Migrate user interface.

CloudM do not take any responsibility or liability for the development, use or ongoing maintenance of any third party application that connects to CloudM Migrate via the API. 


First, download SQL Server Management Studio .

You will be required to change the Role within SQL Server to Super Admin. This will allow the user to log in to the CloudM Migrate API.

To change the Role ID:

  1. Click the Start icon on the desktop of your PC,
  2. Open SQL Server,
  3. Navigate to DB > Tables > Users Table > RoleID,
  4. Right click on the dbo.Users table and select Edit Top 200 Rows,
  5. In the table, find the desired user login email in the Login column,
  6. In this row, change the Role ID from "2" to "1" for Super Admin.


  1. Save the table to confirm any changes.


Configuring the CloudM Migrate API

The CloudM Migrate API Open API specification can be found here.

  1. Open a browser and enter https://cloudm.local/swagger (replacing cloudm.local with your CloudM domain name). This will open the Swagger UI that you can use to configure access to the CloudM Migrate API from your own application.
  2. Select AuthenticationAPI.


  1. On the Authentication API screen, go to the /api/automation/token section.
  2. In the Parameters section, click on the Example value field to populate the model field with the correct data format,
  3. Change the Login and Password values from "string" to your CloudM Migrate Login and Password.


  1. Once a valid login and password has been entered, click on Try it out. If the data is valid, an access token will be generated which you should copy. The token expires after 10 hours.
  2. In the upper right corner of the screen, in the api_key field, enter bearer, followed by a space, followed by the saved access key. This is case sensitive and the space in between is essential
  3. Click the Explore button next to the field.



Get a list of your created migrations

In the Swagger UI:

  1. Navigate to MigrationAPI > /api/automation/migration
  2. Select the Try it out button.


  1. The following report will be generated where:
    • id = The ID of the configuration,
    • projectId = The ID of the project that the current configuration belongs to,
    • name = The name of the configuration



Get details of an existing migration

To get details of an existing migration:

  1. You will need the copy the id of the required configuration (as requested in the section above),
  2. Navigate to MigrationAPI > /api/automation/migration/{id},
  3. Enter the id in the id value field (under Parameters),
  4. Select the Try it out button.


  1. This will provide the following report on the existing migration (in the Response Body section), and will include (amongst others) ID, Project ID, Name, Source Platform, Destination Platform, Migration Process State and the Creation Date.




Was this article helpful?
0 out of 0 found this helpful