Skip to main content
Version: 1.19.1

API reference

LiveData Migrator exposes a REST API for use by external clients. These API resources provide equivalent functionality to the commands described in the Command reference except for the commands related to metadata migrations.

You can access the API documentation for LiveData Migrator directly on your host machine while LiveData Migrator is running:
http(s)://<ldm-hostname>:<ldm-port>/ldm-api.html

Your ldm-hostname must be 127.0.0.1 or localhost by default.

URL for Swagger-based REST API documentation on your server:
http://localhost:18080/ldm-api.html

Swagger Docs

To access the API documentation from your system's public IP address, follow the steps below.

Access REST API documentation on your network#

LiveData Migrator's API documentation can only be viewed from the LiveData Migrator host machine by default. This prevents unauthorized access from other machines. However, if you need to access the documentation from another system over your network, take the following steps:

  1. Open /etc/wandisco/livedata-migrator/application.properties.

  2. Delete or comment out the server.address=127.0.0.1 line.

  3. Save the file changes.

  4. Restart the LiveData Migrator service to apply the change:

    systemd command
    systemctl restart livedata-migrator
    Older versions of Linux without systemd command
    service livedata-migrator restart
  5. Check that access to the documentation is now available on your network:

    Example
    http://ldm-hostname:18080/ldm-api.html
    

    Replace ldm-hostname with the host name or IP address of the system running the livedata-migrator service.

  6. (Optional) Once you have finished using the documentation, consider restoring the server.address entry to secure its access.

Metadata migrations#

Commands related to metadata migrations (such as hive agent, hive rule, hive migration) work through a different REST API port.

Access the API documentation for metadata migrations on your host machine:

http(s)://<hvm-hostname>:<hvm-port>/docs

Your hvm-hostname must be 127.0.0.1 or localhost by default.

Example
http://localhost:6780/docs
note

Your hivemigrator service host name is the same as your livedata-migrator service host, but you must use port 6780 instead of port 18080 to connect to the hivemigrator host.

To access the API documentation from your system's public IP address, follow the steps below.

Access metadata migration API documentation on your network#

API documentation for metadata migration can only be viewed from the host machine by default. This prevents unauthorized access from other machines. However, if you need to access the documentation from another system over your network, take the following steps:

  1. Open /etc/wandisco/hivemigrator/application.properties.

  2. Delete or comment out the line micronaut.server.host=127.0.0.1.

  3. Save the file changes.

  4. Restart the Hive Migrator service to apply the change:

    service hivemigrator restart
  5. Check that access to the documentation is now available on your network:

    Example
    http://hvm-hostname:6780/docs
    

    Replace hvm-hostname with the host name or IP address of the system running the hivemigrator service.

  6. (Optional) Once you have finished using the documentation, consider restoring the server.address entry to secure its access.