Using Postman to create multiple Websites via API & CSV? | Product Discussions

Kel L · 2023-04-17T15:50:47Z

Hi,I’m testing out creating websites (or resources) via the API. I have a standard Post working in Postman just fine. However, when I then try to do the same thing via a CSV file in the Runner section, I’m getting 401 Authorization errors.When I look at the data that’s being sent, it looks the same as what’s sent when I run it manually.Is there something special I need to do when running a Post command via the Runner vs the manual Send command?Thanks.

Kel L

OP2 years ago

Well, just bumping this because it came up again yesterday. I was able to create a device group with no issues, but simply by change it from device/groups to website/groups made it all break. It ended up being the version. When I tried to add it to the URL it didn’t help. What seemed to work was to specify it in the header like this:

Once I did that, everything seemed to start working. Just in case it comes up for me again, I’m documenting it here. Or if it helps anyone else, there you go. :)

Steven Villardi

·3 years ago

Hey there, just wanted to throw out a mention for the Logic.Monitor PS module. It is a wrapper for the LM API and works to make working with the API easier for admins use to interfacing with powershell. There are around ~150 cmdlets with more being added each week. Feel free to check it out as it will make light work of what you are attempting to do without having to learn python.

GitHub:

https://github.com/stevevillardi/Logic.Monitor

PS Gallery:

https://www.powershellgallery.com/packages/Logic.Monitor/

Intro post with some quick start info:

https://community.logicmonitor.com/lm-tech-talk-33/logic-monitor-powershell-module-3562

Amanda Cook

·3 years ago

Hey there,

I am by no means the most organized PowerShell person, but I have successfully gotten this working by reading a csv file for my website names. Additionally I have put the API credential and header work into a function and I call that when you see send-request.

CSV Example

google.com

amazon.com

$websites = Import-Csv -Path "PUT YOUR FILE PATH HERE" header name

$resourcePath = "/website/websites/"

$queryParams = ""

# Loop through each website and create a new website with the given request body

$i=0

foreach ($website in $websites){

$data='{

"type": "webcheck",

"domain": "' + $websites[$i].name + '",

"testLocation": {

"smgIds": [2, 3, 4]

},

"name": "' + $websites[$i].name + '",

"steps": [

{

"url": "' + $websites[$i].name + '",

"timeout": 120

}

]

}'

#Main Client Group

#$data='{"type":"webcheck","domain":"' + $websites[$i].name + '","testLocation":{"smgIds":[2, 3, 4]},"name":"' + $websites[$i].name + '","steps":[{"url":"' + $websites[$i].name + '","timeout":120}]}'

$results = Send-Request $resourcePath $httpVerb $queryParams $data

write-host $data

Write-Host $results

$i = $i + 1

}

Also, for website groups I use this:

$CsvFilePath = "C:\Temp\SiteCodes.txt"

# Read the CSV file

$SiteCodes = Import-Csv -Path $CsvFilePath -header siteCode

$resourcePath = '/dashboard/groups/'

# Loop through the site codes and create dashboard groups

foreach ($SiteCode in $SiteCodes) {

# Build the JSON request body

$data = @{

name = "$($SiteCode.siteCode) Dashboard Group"

} | ConvertTo-Json

# Send the API request to create the dashboard group

$Response = send-request -resourcePath $resourcePath -httpVerb POST -data $data

# Print the response to the console

Write-Output "Dashboard group created: $($Response.name)"

}

Maybe this helps and maybe not but figured I would share what worked for me.

kendall

·3 years ago

import json

response_dict = json.loads(response_string)

This code you shared above will not work. parsed = json.loads(response.content) will work, but not the way you previously wrote it... I illustrated further so it wasn’t as confusing for someone just getting started.

LM User

·3 years ago

parsed = json.loads(response.content) works just as well. No need to set it as a variable if you’re only going to reference it once.

kendall

·3 years ago

To add to Stuart’s advice @Kelemvor , you will also need to add something similar:

strdata = response.content

parsed = json.loads(strdata)

If you don’t add the bolded line above, json.loads() will not work properly.

LM User

·3 years ago

json.loads(x) takes a string (x) and converts it from json format into a dictionary. json load string.

json.dumps(y) takes a dictionary (y) and converts it from a dictionary into a string in json format. json dump string.

LM User

·3 years ago

Converts from the json string to a python dictionary (equivalent to posh hashtable)

LM User

·3 years ago

import json

response_dict = json.loads(response_string)

Kel L

OP3 years ago

OK. I decided to start over. I installed VSCode and have Python working. I’m able to do GETs now, but the data is coming back in a format with a ton of \n’s in it as text. Do I need to do something to get the results with actual line returns so it’s readable?

Thanks for all the assistance so far.

E.g.

{\n "id" : 62,\n "name" : "Client Portal",\n "description" : "",\n "disableAlerting" : false,\n "stopMonitoring" : false,\n "parentId" : 120,\n "alertStatus" : "none",\n "alertStatusPriority" : 100000,\n "sdtStatus" : "none-none-none",\n "alertDisableStatus" : "none-none-none",\n "userPermission" : "write",\n "rolePrivileges" : [ ],\n "numOfDirectSubGroups" :
0,\n "fullPath" : "Prod/Client Portal",\n "groupStatus" : "alive",\n "subGroups" : [ ],\n "hasWebsitesDisabled" : false,\n "numOfWebsites" : 0,\n "properties" : [ ],\n "numOfDirectWebsites" : 0,\n "testLocation" : {\n "smgIds" : [ ],\n "collectorIds" : [ ],\n "all" : true,\n "collectors" : [ ]\n }\n }, {\n "id" : 63,\n "name" : "Marketing Site",\n "description" : "",\n "disableAlerting" : false,\n "stopMonitoring" : false,\n "parentId" : 120,\n "

kendall

·3 years ago

That’s wrong. Query parameters and data are two different things. You can have query parameters in a POST. The difference is that for a GET, LM’s API doesn’t require any payload, which is why the data variable is set to an empty string in the GET script.

I was referring to how to use LM API, not in general, so my assertion stands and the code works.

LM User

·3 years ago

That’s wrong. Query parameters and data are two different things. You can have query parameters in a POST. The difference is that for a GET, LM’s API doesn’t require any payload, which is why the data variable is set to an empty string in the GET script.

kendall

·3 years ago

@Kelemvor ~ check the differences noted in these screenshots:

So basically, with a get, the query parameters are sent by appending to the url (first screenshot). With a post, the data is sent with the request (second screenshot).

LM User

·3 years ago

Because the GET does not need the payload, so your signature also shouldn’t include the payload.

Kel L

OP3 years ago

Well, I’m not sure what changed, but I was able to get the POST to work and create a website. However, why would I have success POSTing to a website, but then get an Authentication Error when I change it to a GET to grab website Groups, without changing anything else?

Argh!

I can do a GET just fine with resource groups, alerts, etc, but as soon as I try to do website groups It fails. Is there something special about that one?

kendall

·3 years ago

I disagree…

And I respect your opinion. However, some customers just want to see how the api works or test basic functionality. Also, the requests library is widely used and still actively developed. It’s just an easier way to get started.

LM User

·3 years ago

I disagree that people new to Python should first learn the Requests method of interacting with LM’s API. That’s like making people learn how to rebuild an internal combustion engine before being allowed to buy an electric car.

Use the SDK; it’s object oriented and much easier to get started with, especially for new Python programmers.

I had a similar experience when learning Python. I was trying to learn how to code robots for the Raspberry Pi. I took all their examples, learned all the long methods and studied how those methods perfectly aligned with the physical hardware in a very bare metal way. It was hard, but I was able to do what I needed to do. Then the gpiozero library came out, which is an SDK for the bare metal GPIO calls. Some of my code blocks went from 50-70 lines to two (2). Every time I built something new using gpiozero, I was astounded at how much more simple things were. I didn’t have to create a pulldown resistor object, then instantiate another object with that object and the pin object just so i could call it. I could just create an LED and pass it the pin number and voila, I had a working LED.

Just because the Requests method of interacting with the API exists doesn’t mean it’s the right way for everyone or even most people. Most people who are using LM aren’t full time developers. They’re infrastructure admins who don’t necessarily want to shift to being developers. They’re part time developers for whom the SDK is a great tool.

Consider the example I showed earlier, which is a complete working example of adding a website to LM:

from lm import lm<br/><br/>body = {<br/>    "testLocation": {"all": False,"smgIds": [2, 3, 4]}, <br/>    "groupId": 1, <br/>    "description": "", <br/>    "type": "webcheck", <br/>    "isInternal": False, <br/>    "name": "google.com", <br/>    "domain": "google.com", <br/>    "schema": "https", <br/>    "steps": [{}], <br/>    "useDefaultAlertSetting": True<br/>}<br/>response = lm.add_website(body)<br/>print(response)

This makes use of my lmwrapper library to simplify all your API interactions. The `from lm import lm` line imports the sdk, sets up the object, passes in your credentials (from a file you have stored outside the script because you should never put your credentials in the script), and otherwise gets everything ready to go. Body creates the definition you want to add and the lm.add_website() method adds it. This is the entirety of the script needed to add a website using the SDK.

Compare this to any script (even any of mine) that use the request library to interact with the API directly. Not only is the code longer, but there are steps in there that aren’t always understood and should never be coded more than once (that’s what imports are for).

Shorter code through the SDK is easier to read and understand what is going on.

kendall

·3 years ago

I’d take a Python shell. I guess I could just use the one from the LM example page, but those are old.

All I’d have to do is change the APIKey stuff and then sub in my “Data” information, right? One of the main reasons I was learning Python is for API stuff, but I’m just going through an online course so I don’t know when we’ll get to that part. ;)

You can, of course, take a shell from our support docs, but unfortunately our docs haven’t quite kept pace with the development of our API, and most of those scripts reflect v1 or v2. The script from the repo I linked yesterday (https://github.com/krshearman/LMAPI_v3/blob/main/PostAddWebsite.py) has been recently tested and is working. All you’ll need to do is add your company name, creds, and your own data.

Hope it helps@Kelemvor !

LM User

·3 years ago

I’d take a Python shell. I guess I could just use the one from the LM example page, but those are old.

Yeah, it should work. If it doesn’t maybe they’ll finally update them and/or start showing examples using the SDK. Make sure to add the header to force it to v3 of the API:

#!/bin/env python<br/><br/>import requests<br/>import json<br/>import hashlib<br/>import base64<br/>import time<br/>import hmac<br/><br/>#Account Info<br/>AccessId ='API-ACCESS-ID'<br/>AccessKey ='API-ACCESS-KEY'<br/>Company = 'apiAccount'<br/><br/>#Request Info: Add a service<br/>httpVerb ='POST'<br/>resourcePath = '/service/services'<br/>data = '{"type":"ping","name":"LMCertification","disableAlerting":false,"pollingInterval":5,"host":"www.logicmonitor.docebosaas.com"}'<br/><br/>#Construct URL <br/>url = 'https://'+ Company +'.logicmonitor.com/santaba/rest' + resourcePath<br/><br/>#Get current time in milliseconds<br/>epoch = str(int(time.time() * 1000))<br/><br/>#Concatenate Request details<br/>requestVars = httpVerb + epoch + data + resourcePath<br/><br/>#Construct signature<br/>signature = base64.b64encode(hmac.new(AccessKey,msg=requestVars,digestmod=hashlib.sha256).hexdigest())<br/><br/>#Construct headers<br/>auth = 'LMv1 ' + AccessId + ':' + signature + ':' + epoch<br/>headers = {'Content-Type':'application/json','Authorization':auth,'X-Version':'3'}<br/><br/>#Make request<br/>response = requests.post(url, data=data, headers=headers)<br/><br/>#Print status and body of response<br/>print 'Response Status:',response.status_code<br/>print 'Response Body:',response.content

Suggest you not use the example destination. That website hasn’t existed for years (at least 4 that I know of).

Kel L

OP3 years ago

I’d take a Python shell. I guess I could just use the one from the LM example page, but those are old.

All I’d have to do is change the APIKey stuff and then sub in my “Data” information, right? One of the main reasons I was learning Python is for API stuff, but I’m just going through an online course so I don’t know when we’ll get to that part. ;)

kendall

·3 years ago

OK, adding ?v=2 or 3 to the resourcepath now gives me an Authentication error. 1401. Making progress I guess.

To pass the version header, add this @Kelemvor :
$headers.Add("X-Version",'3')

Just under the other lines that are similar.

Otherwise, I have a working python script to add a website here: https://github.com/krshearman/LMAPI_v3/blob/main/PostAddWebsite.py

LM User

·3 years ago

I’m pushing Python so I don’t have to learn Powershell just to be able to help you. ;-)

LM User

·3 years ago

See, I don’t know Python.

Learn how to do API calls in PS vs. learn how to do Python. 6’s really. I get it though. I’m having to learn two new tools and mongodb. I can’t count the number of times I’ve said, “see, if it just used jinja2 templating, i’d be done by now”.

Kel L

OP3 years ago

See, I don’t know Python. I’m working on learning it but still a beginner. That’s why I got excited when Powershell was mentioned since I’ve been using that for years, just never for API calls. No luck with adding it to the header. Still poking around.

Thanks!

LM User

·3 years ago

Try switching it to the header. That way there’s no way it can be involved in the signature calculation.

Also, switch to Python and use the SDK:

from lm import lm<br/><br/>body = {<br/>    "testLocation": {"all": False,"smgIds": [2, 3, 4]}, <br/>    "groupId": 1, <br/>    "description": "", <br/>    "type": "webcheck", <br/>    "isInternal": False, <br/>    "name": "google.com", <br/>    "domain": "google.com", <br/>    "schema": "https", <br/>    "steps": [{}], <br/>    "useDefaultAlertSetting": True<br/>}<br/>response = lm.add_website(body)<br/>print(response)

Kel L

OP3 years ago

OK, adding ?v=2 or 3 to the resourcepath now gives me an Authentication error. 1401. Making progress I guess.

LM User

·3 years ago

$headers.Add("X-Version",'3')<br/>

Can’t remember if it should be a string or not. Not a POSH guy anyway, so i don’t know if it matters even.

LM User

·3 years ago

We posted at the same time. I think the problem is that you’re not forcing it to use v3.

LM User

·3 years ago

I’m not sure where it’s getting all the CSS stuff from as it’s not in the code anywhere. I even copied and pasted into Notepad first to try to remove any formatting.

This is in the response from the server. Instead of returning json, it’s returning HTML. That shook something loose: Are you setting it to use v3 of the API? Either add a query parameter `v=3` or a header X-Version : 3. If you’re using v3 of the API, it should be returning json no matter what the error is. The fact that you’re getting HTML back might mean you’re hitting v2 or (eek) v1 of the API.

Kel L

OP3 years ago

Here’s the whole script in case anything jumps out at you.

<# Use TLS 1.2 #><br/>[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12<br/><br/><# account info #><br/>$accessId = 'xxxx'<br/>$accessKey = 'xxxx'<br/>$company = 'xxxx'<br/><br/><# request details #><br/>$httpVerb = 'POST'<br/>$resourcePath = '/website/websites'<br/><br/><br/>$data = '{ "type": "webcheck", "domain": "google.com", "name": "Test from Powershell", "useDefaultLocationSetting": true, "useDefaultAlertSetting": true, "schema": "https", "disableAlerting": true, "groupId": "332","testLocation": { "smgIds": [ 2, 4, 3 ], "collectorIds": [], "all": false, "collectors": [] }, "steps": [ { "type": "config", "name": "__step0", "description": "", "enable": true, "label": "", "HTTPHeaders": "", "followRedirection": true, "HTTPBody": "", "HTTPMethod": "GET", "postDataEditType": null, "fullpageLoad": true, "requireAuth": false, "auth": null, "timeout": 30, "HTTPVersion": "1.1", "schema": "http", "url": "", "matchType": "plain", "keyword": "", "path": "", "invertMatch": false, "statusCode": "", "reqScript": "", "reqType": "config", "respType": "config", "respScript": "", "useDefaultRoot": true }] }'<br/><br/><br/><# Construct URL #><br/>$url = 'https://' + $company + '.logicmonitor.com/santaba/rest' + $resourcePath<br/><br/><# Get current time in milliseconds #><br/>$epoch = [Math]::Round((New-TimeSpan -start (Get-Date -Date "1/1/1970") -end (Get-Date).ToUniversalTime()).TotalMilliseconds)<br/><br/><# Concatenate Request Details #><br/>$requestVars = $httpVerb + $epoch + $data + $resourcePath<br/><br/><# Construct Signature #><br/>$hmac = New-Object System.Security.Cryptography.HMACSHA256<br/>$hmac.Key = [Text.Encoding]::UTF8.GetBytes($accessKey)<br/>$signatureBytes = $hmac.ComputeHash([Text.Encoding]::UTF8.GetBytes($requestVars))<br/>$signatureHex = [System.BitConverter]::ToString($signatureBytes) -replace '-'<br/>$signature = [System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes($signatureHex.ToLower()))<br/><br/><# Construct Headers #><br/>$auth = 'LMv1 ' + $accessId + ':' + $signature + ':' + $epoch<br/>$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"<br/>$headers.Add("Authorization",$auth)<br/>$headers.Add("Content-Type",'application/json')<br/><br/><# Make Request #><br/>$response = Invoke-RestMethod -Uri $url -Method $httpVerb -Body $data -Header $headers <br/><br/><# Print status and body of response #><br/>$status = $response.status<br/>$body = $response.data| ConvertTo-Json -Depth 5<br/><br/>Write-Host "Status:$status"<br/>#Write-Host "Response:$body"

LM User

·3 years ago

Ok, are you converting your payload to json before sending it?

Kel L

OP3 years ago

Yeah, that’s what I found online, but the Headers section in the script seems to be setting that.

<# Construct Headers #>
$auth = 'LMv1 ' + $accessId + ':' + $signature + ':' + $epoch
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Authorization",$auth)
$headers.Add("Content-Type",'application/json')

LM User

·3 years ago

You need to set the Content-Type header to application/json. Your request probably didn’t specify the type of content it was passing in so the API doesn’t know how to parse your payload; the api doesn’t assume your payload is json.

Kel L

OP3 years ago

Any idea what this error means? Just trying to create a website via the API. I’m using the same “Data” as I use in Postman and it works fine there, but not from Powershell. I’m not sure where it’s getting all the CSS stuff from as it’s not in the code anywhere. I even copied and pasted into Notepad first to try to remove any formatting.

Invoke-RestMethod : HTTP Status 415 – Unsupported Media Typebody {font-family:Tahoma,Arial,sans-serif;} h1, h2, h3, b {color:white;background-color:#525D76;} h1 {font-size:22px;} h2 {font-size:16px;} h3 {font-size:14px;} p {font-size:12px;} a {color:black;} .line {height:1px;background-color:#525D76;border:none;}HTTP Status 415 – Unsupported
Media TypeType Status ReportMessage Unsupported Media TypeDescription The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource.LogicMonitor Technical Operations
At line:52 char:13
+ $response = Invoke-RestMethod -Uri $url -Method $httpVerb -Body $data ...
+             ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (System.Net.HttpWebRequest:HttpWebRequest) [Invoke-RestMethod], WebException
    + FullyQualifiedErrorId : WebCmdletWebResponseException,Microsoft.PowerShell.Commands.InvokeRestMethodCommand
Status:200

Joe Williams

·3 years ago

The examples on that page and mine above will work with V3, the returned data structure is just different.

Kel L

OP3 years ago

Ah thanks. I’ll take a look. I also found this page, but it says it’s from v1. Hopefully it still works too.

https://www.logicmonitor.com/support/rest-api-developers-guide/v1/rest-api-v1-examples

Mike Moniz

·3 years ago

I’m not familiar with Postman at all myself but one thing about LM API calls is that you need to include any POST/PUT data into the sha256 algorithm that is used in the LMv1 auth header or it will fail. So need to make sure Postman is doing that when using the “Runner” section you talked about.

For PowerShell, there are some unofficial modules in PSGallery otherwise LM provides some examples at https://www.logicmonitor.com/support/rest-api-developers-guide/v1/rest-api-v1-examples#h-powershell-examples, just add the X-Version header to use APIv3 (v1 and v2 are going to be depreciated soon)

Joe Williams

·3 years ago

This is dirty but should get the idea out there. This was a tab delimeted file not a csv but reading a csv is pretty simple.

$accessId = ''<br/>$accessKey = ''<br/><br/>$ParentFolder = '5937'<br/><br/>$httpVerb = 'POST'<br/>$resourcePath = '/device/groups'<br/>$url = 'https://PORTAL.logicmonitor.com/santaba/rest' + $resourcePath<br/><br/>$Locations = Import-Csv C:\Users\user\Downloads\folders.txt -Delimiter "`t" -Header "SiteName","Street","City","State","Zip"<br/><br/>foreach ($Location in $Locations) {<br/>    Write-Host $Location.SiteName<br/>    $data = '{"name":"' + $Location.SiteName + '","parentId":' + $ParentFolder + ',"customProperties":[{"name":"location","value":"' + $Location.Street + ", " + $Location.City + ", " + $Location.State + " " + $Location.Zip + '"}]}'<br/>    $epoch = [Math]::Round((New-TimeSpan -start (Get-Date -Date "1/1/1970") -end (Get-Date).ToUniversalTime()).TotalMilliseconds)<br/>    <# Concatenate Request Details #><br/>    $requestVars = $httpVerb + $epoch + $data + $resourcePath<br/><br/>    <# Construct Signature #><br/>    $hmac = New-Object System.Security.Cryptography.HMACSHA256<br/>    $hmac.Key = [Text.Encoding]::UTF8.GetBytes($accessKey)<br/>    $signatureBytes = $hmac.ComputeHash([Text.Encoding]::UTF8.GetBytes($requestVars))<br/>    $signatureHex = [System.BitConverter]::ToString($signatureBytes) -replace '-'<br/>    $signature = [System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes($signatureHex.ToLower()))<br/><br/>    <# Construct Headers #><br/>    $auth = 'LMv1 ' + $accessId + ':' + $signature + ':' + $epoch<br/>    $headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"<br/>    $headers.Add("Authorization",$auth)<br/>    $headers.Add("Content-Type",'application/json')<br/><br/>    $response = Invoke-RestMethod -Uri $url -Method $httpVerb -Header $headers -Body $data<br/>}

Kel L

OP3 years ago

I have no idea. I don’t know Postman or Python very well, but I do know Powershell. Although I’ve never used it for doing any API stuff. Do you have a sample of using Powershell do hit the LM APIs by chance that I could use as a starting point?

Thanks.

Joe Williams

·3 years ago

Is the pre-request script running each time you are making the call?

Personally this is something I would use Python or Powershell for. Loop through the items in the csv then call the API or SDK with that.