If you would like to create an API key in order to query and monitor VM Backup Status Reports for all or even specific customers, you can follow the guide below.

1. Within the VM Backup application in the Control Panel, browse to [Backups] > [Generate Report]
   
   
   
   
   
2. Next, you'll be able to choose the customers or leave that field empty for all customers to be included within the report.
   
   You can also include source IP addresses that you'd like to only have access to this report:
   
   
   
   
   
3. Once you generate the API link together, an API key is provided, copy and take note of them (especially the API Key). This API key will not be displayed again so you must take note of it.
   
   
   
   

4. The example below, will simply be using the Postman application to showcase the functionality. When using the API link provided, as you can see in the screenshot below, X-API-KEY is used as a 'Key' in the HTTP Headers with the 'Value' being the API Key.

   
   This will produce the result in JSON format, example below:
   
   
   
   

   Note that the API can only be accessed at most once every 5 minutes. If you attempt to request the data again in less than 5 minutes you will get a 'Forbidden' or a 'Bad Request' error message, so ensure that the application you're using is set to request new data at least 5 minutes apart.

   
   Ensure that you are requesting the data from an IP address which is allowed to access this data if you chose to limit the originating IP addresses