Disaster Recovery Engine API

Here you can find details about the API of the Disaster Recovery Engine. You can also download the specification in YAML format.

API calls use the http://HOST:PORT/v1/CALL pattern. Replace HOST and PORT with the values described in Host and port for the DRE.

Quick reference

Some operations take arguments as URL query parameters (after ? in the path).

  • Status: all DR services and VMs

    # curl -s http://HOST:PORT/v1/dreStatus

  • Service info

    # curl -s 'http://HOST:PORT/v1/drService?drId=42ae6a4c-e421-48b5-8e90-c6e83368037e'

  • Delete service

    # curl -X POST 'http://HOST:PORT/v1/drServiceDelete?drId=42ae6a4c-e421-48b5-8e90-c6e83368037e'

  • Create service: JSON body

    # curl -X POST -H 'Content-Type: application/json' \
#   -d '{"vmId":"a90e2dee-fad4-405d-b75e-3ea6561d659a","locationId":"abc4","drPolicyName":"hourly-zone-b"}' \
#   http://HOST:PORT/v1/drServiceCreate

  • Recovery points for a service

    # curl -s 'http://HOST:PORT/v1/recoveryPoint?drId=42ae6a4c-e421-48b5-8e90-c6e83368037e'

  • Delete recovery point copy

    # curl -X POST 'http://HOST:PORT/v1/recoveryPointDelete?recoveryPointId=44d4e71f-e320-4af8-a198-28a279b5994e&where=local'

  • VM metadata for a recovery point

    # curl -s 'http://HOST:PORT/v1/metadata?recoveryPointId=44d4e71f-e320-4af8-a198-28a279b5994e'

REST API