- API Usage Guide
- API Command Reference
- Appendix A - Activity Codes
- Appendix B - Setting Names
- Appendix C - Error Handling
- Code Samples
- Release Notes
API Usage Guide
Making API calls
API calls can be made in a couple of ways:
API calls via HTTPTo make an API call, your application will need to perform an HTTP POST transaction (HTTP GET requests can also be enabled - see API Settings) to http(s)://your_midas_url/api.pl. Each request must include as a minimum your unique API key, an API command and all associated required parameters for the API command issued. Please refer to the API Command Reference for details of available API commands and associated parameters.
- Your application must be able to establish secure connections over TLS 1.2 or TLS 1.3 to our servers. Older TLS 1.0/1.1 connections are not supported.
- In order to ensure service quality for all our hosted customers, we rate-limit connections to our servers. Please ensure you limit the rate of API calls to your hosted MIDAS system to no more than 60 calls per minute. Excessively high rates of API calls may result in your IP address being automatically blocked and/or your API access suspended.
API calls from the Command Line(Available in API v2.19+ for self-hosted editions of MIDAS only)
In addition to making API calls via HTTP, the API also permits calls to be made directly from the command line. API calls made in this way have the added benefit of being significantly faster (assuming the call is made from the command line on the same server as the MIDAS system), as they do not require an HTTP transaction to be conducted.
To make API calls from the command line, simply call "api.pl" (located within your server's MIDAS directory) and pass API parameters & values via command line switches.
For example, to retrieve the currently installed version of MIDAS from the Windows command line (cmd):
...or from Windows PowerShell: