API v4

As per the REST API Change Log, API V4 exists and is REALLY powerful and efficient.

We make a lot of heavy requests to the LogicMonitor API and want us (and the poor LogicMonitor servers) to benefit from these efficiency gains.

As per the official docs, means of accessing the API v4 have been removed:

https://www.logicmonitor.com/support/rest-api-change-log . A search for "V4" reveals:

Block Access to LM REST API v4 using Bearer Token

Starting with v198 release, you will not be able to use bearer token to authenticate yourself to use LogicMonitor REST API v4 external endpoints. We have already disabled Basic and LMv1 authentication to use API v4. Note that API v4 is not officially supported. We recommend you to use LogicMonitor REST API v3.

Great, but the implication is that it there IS a way of authenticating.

So.. UNOFFICIALLY... Has anyone successfully made an API V4 call in (e.g.) Postman?

David Bond

Posted 1 year ago·Last reply 1 year ago

12 comments

Henry Steinhauer

·1 year ago

I'm also very interested in the ability to pull data out of LM to be used in other tools for analysis.

Is there a customer board that is meeting with the development team to work through some of these differences in usage that appear to be showing?

Based on just this thread it sounds like Befuddled and David Bond would be two people that would be providing great input for expanding the usage of the application.

We are also a big user of the PowerShell API interface that is out there and have found that when Filtering to pull device lists of other processing that has a big benefit in the processing speed of the usage.

Our company has grown because of M&A work. That has left us to work through the addition of adding other networks to our base. The API process has greatly assisted that process.

jake_nahm

·1 year ago

Hi David_Bond ,

A few points to emphasize. The reasons APIv4 is unsupported are because:

APIv4 was built solely to power UIv4 -- so its not intended to be consumed / used by an end user
APIv4 is likely to change from release to release
LogicMonitor has invested significantly in APIv3 to ensure this is the version optimal for end user use

Would you be able to elaborate on what you're able to accomplish on API v4, as it relates to efficiency and other gains? Happy to hop on a call to discuss further.

David Bond

OP1 year ago

Multiple reasons for wanting APIv4 access, but I'll set out a few:

Query efficiency: The HUGE power of LogicMonitor as a monitoring platform is it's API. It makes it ideally suited for MSP automation. If we can efficiently configure LogicMonitor, we can add LOTS of resources very quickly and efficiently (e.g. when migrating customers from SolarWinds). Further, we can get the monitored data back out very efficiently, setting effective filters is essential for query performance. Querying the list of instances is currently VERY slow because we have to do tree walking, for example. We can see (in Browser tools) that APIv4 is a MUCH more query-oriented approach - highly commendable, but MSPs and system integrators such as ourselves ALSO want this power!
APIv4-exclusive endpoints: We can see that the Usage data is APIv4 only. In APIv3, for the longest time, endpoints being undocumented didn't matter, as we could easily reverse engineer. As yes, the undocumented endpoints would change, and yes, we had to adapt/cope with that change! We have been doing so for 15 years, the result of which is that many large MSPs are now highly automated and integrated. Frankly, this makes LogicMonitor much "stickier" and reduces churn. Now it seems, the only way to report on usage data in external tools is to (gulp) screenshot LogicMonitor(!)
Innovation: Advances in the API encourages innovation from technology ecosystem partners such as ourselves. This is NOT how Apple writes apps. They publish the API and the result is a highly profitable Apple app marketplace. By hiding APIv4 away exclusively for LogicMonitor-internal use, this innovation around LogicMonitor is neutered.

So what's the IMMEDIATE need for us? Well serveral of our MSP customers want branded customer-facing reports on data now only available behind APIv4. Let's take Account Usage as the simple example. Please either a) let us know how to access that via APIv3 or b) open up APIv4!

jake_nahm

·1 year ago

Hi David.

We appreciate the positive sentiment toward LogicMonitor and our APIs. We are planning to support API v3 endpoint access for usage related data, which is on our roadmap.

As stated earlier, and our focus remains in investing into API v3 as our flagship API.

Rob Sapsford

·1 year ago

Jake,
That is a typical LogicMonitor response.

It comes across as "We value your call. Please continue to hold".

It doesn't address any of David's completely valid points, which I couldn't agree more with. The query inefficiency in API v3 is a major roadblock for my company, along with the inability to reverse engineer in the new UI.

..and to quote Mr. Bond "By hiding APIv4 away exclusively for LogicMonitor-internal use, this innovation around LogicMonitor is neutered."

This, along with a few other things, is why I have stopped recommending LogicMonitor as a solution for MSPs.

Sarah_Terry

·1 year ago

befuddled As Jake mentioned, APIv4 was designed solely to support UIv4. The format is unfortunately not intended for end user consumption. This & the flexibility allotted to our developers in having it solely support the UI (vs also being relied on by end users) is why it's not been published.

That being said, we are absolutely committed to exposing new innovation via API, and are working towards an API first strategy with all new features to facilitate this. The API version we publish for new features will be APIv3, however.

David_Bond the specific examples are super helpful. We are actively working on publishing the usage page API (into the v3 version), and we can take a look at the query efficiency in v3 vs v4 to see what might be able to be done to make querying more efficient for end users using the API. If your use case is trying to get bulk data out of LM, we also have a data publisher feature that may be worth a separate discussion, as it is much more scalable than the API.

David Bond

OP1 year ago

Thanks Sarah_Terry 🙂

The specific use cases / examples that spring to mind:

Instance querying

Give me a pageable list of instances (including a paging token) that meet the following criteria:
- Instance-level property port.usage_type == 'uplink'
- AND Resource-level property is.managed == 'true'
- AND Resource-level property customer.code == 'ABC'
- AND (DataSource = 'Network_Interfaces' OR DataSource = 'snmpif_64')
Page of Website steps (including a paging token) where:
- SSL checks are disabled
- Website-level property is.managed == true
Page of Instances added or modified since <time cursor>
Page of Instances deleted since <time cursor>
Page of instance Groups
Page of Alert Thresholds
Page of ResourceDataSourceSdts at all levels
Page of OpsNotes

Undocumented APIv3 items

The documentation is not up to date
Enums should be documented (most are not)

Information only currently available in APIv4

e.g. Usage data

David Bond

OP1 year ago

On the data publisher feature - this does sound great! Looking forward to hearing about that. Please do DM any information that you can.

Sky Donnell

Admin1 year ago

Hi David,

Great question, and we completely understand the ask. Just a heads-up that API v4 isn’t officially supported and is meant for internal use only. Since it’s not supported, changes can happen anytime and might break anything built on it.

For this reason, we recommend sticking with API v3. If you're running into performance issues or have specific needs, feel free to reach out—we’re happy to help you explore options!

Rob Sapsford

·1 year ago

What's the roadmap for API v4 to be officially supported?

jake_nahm

·1 year ago

Hi befuddled

Support of API v4 is currently not on the roadmap. The LM APIv3 is our recommended API version, and the one we will continue to support and enhance.

David Bond

OP1 year ago

Thanks skydonnell, and I appreciate that it's not supported. However, we're very willing to explore it unsupported if we can just understand the authentication mechanism. Is this documented anywhere, or if not, could I get 15 with someone who could get us up-and-running in Postman?