Mirth® Connect REST API

The Administrator and Command Line Interface both use a well-defined API to communicate with the Mirth® Connect server. You can also use the same API to create custom integrations of your own. The API is documented at https://localhost:8443/api (change the IP / port as needed), or you can select View Client API in Administrator via Other Tasks:

• Select the View Client API action to open the API documentation in your default browser.
  Note: You may see a warning in your browser if your Mirth® Connect instance is still using the auto-generated self-signed certificate. You can select Advanced and allow the browser to continue to the page. To resolve this warning, look at Application Data Directory for instructions on installing your own certificate.
  

• Select the arrow button on one of the endpoint group rows to view its operations. This list shows the operation's HTTP method type, request URL, and a description for each endpoint.
  

• Select on one of the endpoint rows to view its details. If desired, you can select a specific operation to view only that op's details. Depending on the type of endpoint, the following may be available:
  • Parameters
  • Request Body
  • Responses