Gateway API logs & EventAPI/AlarmAPI accessibility

MIP
, , ,
1

Greetings all,

We are trying to get logs, events, and alarms from the gateway API in milestone 2023 R1, however I didn’t find any GET in the REST API regarding the logs.

then when I tried to access the EvetnAPI/AlarmAPI am getting:

“error”: {

    "httpCode": 404,

    "details": \[

        {

            "errorText": "Unknown resource: events"

        }

    \]

}

based on the documentation the API endpoint is :

https://servername.com/api/rest/v1/events

how can I get logs from the REST API and how to access the EventAPI and AlarmAPI.

regards.

2

The Events API and the Alarms API were both added as beta functionality in 2023R2. You cannot use this in 2023R1. I recommend that you upgrade and use the newest version of the XProtect VMS, currently this is 2023R3.

https://doc.developer.milestonesys.com/html/index.html?base=gettingstarted/mip2023r2_intro.html&tree=tree_home.html

https://doc.developer.milestonesys.com/mipvmsapi/api/events-rest/v1/#section/Quickstart/Requirements

3

Thank you for the feedback,

what about the logs? are they considered under Event/Alarms? or are they not available in the API itself.

4

The API Gateway has logs here. [C:\ProgramData\Milestone\XProtect](file:C:/ProgramData/Milestone/XProtect) API Gateway\Logs

5

I mean Milestone Server logs, such as “Server Logs”, “Audit Logs”, “Rule Logs”.

if they are available in the gateway API, can you specify in which endpoint are they.

6

Those logs are currently available only when using the MIP Library.

You can see a sample that shows how to use this here: https://doc.developer.milestonesys.com/html/index.html?base=samples/componentsamples/logread/readme.html&tree=tree_2.html

I do not have any indication when the access to read these logs might be added into the Rest API. I can only say that it is the intention that more support will be put in the Rest API.