barscaret-downcaret-leftcaret-rightcaret-upcheckchevron-leftchevron-rightfile-pdfinfosign-in-altsignin text-widthtimesyoutube

API & Integrations > API

Miradore API v2

Updated on May 4th, 2021

Miradore API v2 is a HTTPS REST based interface for integrating Miradore with other applications. API v2 provides access to resources via URI and it is suitable for CRUD (create, read, update and delete) operations in Miradore.


Miradore API v2 uses the authentication key which is sent to the server in the request’s HTTPS header “X-API-Key”.

Authentication key is a random string which can be generated from Miradore web console > System > Infrastructure diagram when the API feature is activated. Please read more about creating an authentication key from the article Getting started with API. See additional instructions about managing authentication keys from Adding API keys and Deleting API keys.

Supported items and methods

The Miradore API v2 is used by sending HTTPS requests to Miradore server. The API uses standard HTTPS methods GET, PUT, POST and DELETE. The response format is JSON.
The base URI for API v2 calls:

The technical documentation of Miradore API v2, information about supported items and methods, can be found from the Swagger documentation together with some examples. The documentation is available in: https://<sitename>

It is possible to try out available API v2 operations with Swagger tool. In the tool there is a button “Authorize” from where you can authorize a session with the authentication key received from Miradore.

Example 1: Locking a device

  • The device ID is required as a parameter.

POST https://<sitename>{id}/Lock


Example 2: Get device’s locations from certain time range

  • The device ID is required as a parameter.
  • Optional parameters are startDate and endDate (year-month-day), if you want to define the time range for the results.

GET https://<sitename>{id}/Location


  • This field is for validation purposes and should be left unchanged.

Next Article: