Accessing the LogicMonitor REST API with Postman and LMv1 API Token Authentication
Introduction Postman is widely used for interacting with various REST APIs such as LogicMonitor's. However, there is no out-of-the-box support for the LMv1 authentication method which we recommend as a best practice. This document describes how to configure Postman to use LMv1 authentication when interacting with our REST API. Overview Postman's pre-request script functionality provides the ability to generate the necessary Authorization header for LMv1 authentication. As the name suggests, the pre-request script runs immediately before the request is made to the API endpoint. We set the pre-request script at the collection level in Postman so that it will run automatically for every request that is part of the collection. The script requires three input parameters: a LogicMonitor API token (or ID), its associated key, and the full request URL. These parameters are made available to the script by creating a Postman environment and setting the values as environment variables. If you need to access multiple LogicMonitor accounts (portals), create a separate environment for each to store the applicable API and URL information. Since all API requests to a given account use the same base URL (https://<account>.logicmonitor.com/santaba/rest) it is convenient to store this as an environment variable. The output of the script is the value of the Authorization header. The script writes the header value to an environment variable which is then inserted as the Authorization header value in the request. Instructions 1. Download and install Postman. 2. Launch Postman and create a new collection that will be used for all LogicMonitor API requests. 3. In the create collection dialog, select the "Pre-request Scripts" section and paste in the following code. // Get API credentials from environment variablesvar api_id = pm.environment.get('api_id');var api_key = pm.environment.get('api_key'); // Get the HTTP method from the requestvar http_verb = request.method; // Extract the resource path from the request URLvar resource_path = request.url.replace(/(^{{url}})([^\?]+)(\?.*)?/, '$2'); // Get the current time in epoch formatvar epoch = (new Date()).getTime(); // If the request includes a payload, included it in the request variablesvar request_vars = (http_verb == 'GET'||http_verb == 'DELETE') ?http_verb + epoch + resource_path : http_verb + epoch + request.data + resource_path; // Generate the signature and build the Auth headervar signature = btoa(CryptoJS.HmacSHA256(request_vars,api_key).toString());var auth = "LMv1 " + api_id + ":" + signature + ":" + epoch; // Write the Auth header to the environment variablepm.environment.set('auth', auth); 4. Create a new environment. Create the environment variables shown below. You do not need to provide a value for the "auth" variable since this will be set by the pre-request script. Be sure to use the api_id, api_key, and url values appropriate for your LogicMonitor account. 5. Create a request and add it to the collection with the pre-request script. A sample request is shown below with the necessary parameters configured. 1. Set the environment for the request, 2. Set the HTTP method for the request. 3. Use {{url}} to pull the base URL from the environment variable. Add the resource path and any request parameters your API request may require. 4. Add the Authorization header and set the value to {{auth}} to pull the the value from the environment variable. 5. POST, PUT, and PATCH requests only: if your request includes JSON data, be sure to select the Body tab and add it. 6. Press Send to send the request. The response will appear below the request in Postman. Troubleshooting You receive the response "HTTP Status 401 - Unauthorized" Confirm the following: • The proper environment has been specified for the request. • The necessary environment variables have been set and their values are correct. Note that the script relies on the specific variable names used in this document: "api_id", "api_key", "url", and "auth". • The request is a member of the collection configured with the pre-request script. Postman reports "Could not get any response" or "There was an error in evaluating the Pre-request Script: TypeError: Cannot read property 'sigBytes' of undefined" Make sure you have set the proper environment for the request and all necessary environment variables and values are present.
Automate AWS device group creation
Hello, I'm trying to automate AWS account device group creation. The thing is I will not always have immediate access to the onboarded environment, so I wanted to reuse the external ID as it is possible in the UI (see the attached screenshot). I'm having difficulty finding the proper parameter in Python library, and the creation fails with error {"errorMessage":"No external ID assigned. Please request your external ID first","errorCode":1400,"errorDetail":null}. Is there any way to automate this? Thanks.
hdsId ... minor API question
Apologies if this question seems frivolous or unimportant, but it has always bothered me that the designation for the "device datasource ID" in the API documentation, hdsId, starts with the letter "h". I get that it is the device-specific datasource ID that is unique, for that datasource, to the device. I use it all the time in API calls. But it sort of bugs me that it is hdsId and not ddsId. I'm sort of wondering if any long-term users or employees know why the letter "h" is used in the API documentation, and not "d". If it were ddsId then I would have naturally assumed that the d was meant to be "device". I could even understand rdsId where the "r" was for resource. But nothing is clicking for hdsId. Anybody happen to know? Or did I miss it somewhere in the documentation?What is up with Meraki API Modules?
I know the LM Meraki API Modules have been around for a minute now. But I'm just getting around to testing it out on some of our Meraki-heavy customers and man, does anyone else find it incredibly tedious to try to get to work? I have been having so many issues with it. Netscan is one problem, but that's for another discussion. But then once the devices are added, we get No Data alerts ALL THE TIME. Right now, for example, I have 1644 Warning alerts (No Data) for ONE customer. It's insane how many alerts there are. And it's even scarier that when I look at the Raw Data on others that aren't alerting, they are also showing No Data but just don't have an alert threshold. I don't know if I should be pointing the finger at Meraki or LM here, honestly. But the API modules are so inconsistent, at best. I know the API key, OrgID and NetworkIDs are right because I can use them for API pulls in Python. It just seems to be LM not able to figure it out. And what's worse is how inconsistent it is. Some devices work for some organizations. Others don't. I can't be the only having this issue. And I can hear the critics chiming in now saying, "well then don't use the Meraki API modules." Problem is if we don't, we only get SNMP stats and those are nowhere near as helpful as the API modules, plus the potential to be less secure. Just wondering if there are some fellow LM community friends out there struggling to make the API stuff work for Meraki and LM. Thanks for listening to my rant.API to put Multiple resource in SDT getting Authentication failed
Experts, I am trying to write a script to put multiple resources in SDT via API. However, the script fails with the error: "Authentication failed", "status":1401. This indicates that the API is rejecting my request. The API credentials are correct, as I am successfully using them for other API calls. Has anyone encountered a similar issue? Your insights would be highly appreciated.
REST Query no results
Hello, I'm trying to do a simple query the rest service with a filter of system.hoststatus = normal using the following parameter: systemProperties:"{'name':'system.hoststatus','value':'normal'}" so my entire post string looks like this: https://me.logicmonitor.com/santaba/rest/device/devices?filter=systemProperties:"{'name':'system.hoststatus','value':'normal'}" I'm getting a response, but its always empty: { "status" : 200, "errmsg" : "OK", "data" : { "total" : 0, "items" : [ ], "searchId" : null, "isMin" : false } } Am I fundamentally mis-understanding the syntax for the query? Thanks!Updates for LogicMonitor REST API v1, v2, and v3
Hello LM Community! It’s been a little while since we last shared an update on LogicMonitor API, so we wanted to touch base, and provide you with the latest news. To catch you up to speed, in 2022, LogicMonitor began supporting LogicMonitor REST API version 3 (also known as API v3). Our goal has always been to improve our API experience. Since v3’s introduction in 2022, enhancements and fixes have solely been made to API v3 (not v1 and v2). During planning for the sunsetting of LogicMonitor REST API v1 and v2, we have had many discussions with our customers in order to better understand the various scenarios and challenges that might be faced throughout that sunsetting process. While we continue to encourage all of our customers to migrate to the upgraded API v3, we are temporarily pausing on the actual sunsetting of API v1 and v2. We will keep you updated on those sunsetting plans as they are finalized. Please continue to plan your migrations to API v3, and below you’ll find just a few of the reasons (benefits) for doing so: API v3 is an upgraded version of API v2, and it has all of the latest features and patches Any future enhancements and defect fixes will only be completed for API v3 API v3 has in-depth support documentation for you to reference For more information on LogicMonitor REST API v3, please refer to the below documentation: Using LogicMonitor’s REST API LogicMonitor REST API v3 Swagger Documentation LogicMonitor v3 SDKs Best Practices for Migrating to LogicMonitor v3 SDK LogicMonitor REST API v3 Basic filters LogicMonitor REST API v3 Advanced filters Bearer Token If you have any questions, please contact our Technical Support Team.LogicMonitor.Api C# API nuget 1.191 Released
All that strongly-typed goodness can be found in the usual place: Web: https://www.nuget.org/packages/LogicMonitor.Api/ Visual Studio / VS Code: manage nuget packages for your project/solution and search for "LogicMonitor" Adding LogicMonitor.Api to your project It's THIS easy to print an inventory of all regular Resources (paging is handled automatically): Taking inventory in 25 lines or fewer We will answer your questions on this forum! Please include the word "C#" or "nuget" in your subject line.Provisioning LDAP Application in Sailpoint IIQ
I am new to Sailpoint. I have onboarded LDAP Application, aggregated and next I want to provision a delimited file data to LDAP application. I followed the step this way --> Manage User --> Selected User --> Manage Access --> filter --> Entitlement Application --> LDAP --> Selected and proceeded further. And I get the error every time
Website Downtimes via API
Hi I'd like to use the API to gather information about the availability of my websites. I will have to gather data for monthly and yearly SLA calculation which features the exact downtimes of the website. With these requirements, I don't think the graph data can deliver accurate data enough. So I'm looking into the /website/websites/{webservice_id}/checkpoints/{checkpoint_id}/data API. Getting Data | LogicMonitor The API works fine, but obviously getting all the statuscodes for every check (every minute) for a whole Month, or even year takes a long time and produces a lot of data that I have to crunch. For me, it would be sufficient to get only the data for downtimes, so every status report which is not 1.0. Does anyone know if the API has such a feature? I already ask for only the datapoints, but this would need some additional filtering. params = {'start': start, 'end': end, 'format': 'json', 'datapoints': 'overallStatus' }
