I'm running into an issue with getting results back from the NCM component of SolarWinds while using the API. This issue is the same when using the SWQL API or the SWIS API. My workflow is generally to build a query in SWQL Studio and use that query in an API request using the SWQL API. Also, I'll use the SWIS API where it makes sense, although I'm not really clear when to use this API as the documentation seems sparse. This workflow has been fine when using the Orion endpoint in SQWL Studio, e.g., Orion.AlertDefinitions but I've ran into issues when using the NCM endpoint, e.g., NCM.Nodes. SWQL Studio Query that works and returns data: SELECT TOP 10 I . EntityID , I . ChassisType , I . ChassisName , I . ChassisVersion , I . ChassisID , I . ChassisSerialNumberString , I . FirstDiscovery , EntityID , I . NodeID FROM NCM . CiscoChassis I Snippet of python code using the same query in an API call that doesn't work: # Initiate API request object base_url = auth . get_url ( 2414 ) headers = { 'Authorization' : f "Basic { creds } " , 'Accept' : 'application/json' } requests = request_manager . request_manager ( base_url = base_url , headers = headers ) # Build SWQL query query = [ 'SELECT TOP 10 I.EntityID, I.ChassisType, I.ChassisName, I.ChassisVersion, I.ChassisID, I.ChassisSerialNumberString, I.FirstDiscovery' ] query = "," . join ( query ) # Make API request and display results endpoint = f "Query?query= { query } FROM NCM.CiscoChassis I" r = requests . request ( endpoint = endpoint, method = 'GET') print ( json . dumps ( r . json (), indent = 4 )) #Returns empty string { "results": [] } Using the same python API logic to make calls to Orion.{endpoint} works fine. The python code is basically the same as the orionsdk -- it's just a wrapper for the API using the request lib on the backend.

nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Community
- Command Central
- MVP Program
- Monthly Mission
- Blogs
- Groups
- Events
- Media Vault
Products
- Observability
- Network Management
- Application Management
- IT Security
- IT Service Management
- System Management
- Database Management
Content Exchange
- SolarWinds Platform
- Server & Application Monitor
- Database Performance Analyzer
- Server Configuration Monitor
- Network Performance Monitor
- Network Configuration Manager
- SQL Sentry
- Web Help Desk
Free Tools & Trials
Store

Requests returned from SWQL but not API

Chetim

I'm running into an issue with getting results back from the NCM component of SolarWinds while using the API. This issue is the same when using the SWQL API or the SWIS API. My workflow is generally to build a query in SWQL Studio and use that query in an API request using the SWQL API. Also, I'll use the SWIS API where it makes sense, although I'm not really clear when to use this API as the documentation seems sparse. This workflow has been fine when using the Orion endpoint in SQWL Studio, e.g., Orion.AlertDefinitions but I've ran into issues when using the NCM endpoint, e.g., NCM.Nodes.

SWQL Studio Query that works and returns data:

<span class="s5">SELECT</span><span class="s0"> </span><span class="s5">TOP</span><span class="s0"> </span><span class="s4">10</span><span class="s0"> </span><span class="s11">I</span><span class="s10">.</span><span class="s11">EntityID</span><span class="s10">,</span><span class="s0"> </span><span class="s11">I</span><span class="s10">.</span><span class="s11">ChassisType</span><span class="s10">,</span><span class="s0"> </span><span class="s11">I</span><span class="s10">.</span><span class="s11">ChassisName</span><span class="s10">,</span><span class="s0"> </span><span class="s11">I</span><span class="s10">.</span><span class="s11">ChassisVersion</span><span class="s10">,</span><span class="s0"> </span><span class="s11">I</span><span class="s10">.</span><span class="s11">ChassisID</span><span class="s10">,</span><span class="s0"> </span><span class="s11">I</span><span class="s10">.</span><span class="s11">ChassisSerialNumberString</span><span class="s10">,</span><span class="s0"> </span><span class="s11">I</span><span class="s10">.</span><span class="s11">FirstDiscovery</span><span class="s10">,</span><span class="s0"> </span><span class="s11">EntityID</span><span class="s10">,</span><span class="s0"> </span><span class="s11">I</span><span class="s10">.</span><span class="s11">NodeID</span><span class="s0"> </span><span class="s5">FROM</span><span class="s0"> </span><span class="s11">NCM</span><span class="s10">.</span><span class="s11">CiscoChassis</span><span class="s0"> </span><span class="s11">I</span>

Snippet of python code using the same query in an API call that doesn't work:

# Initiate API request object

<span>base_url</span><span> </span><span>=</span><span> </span><span>auth</span><span>.</span><span>get_url</span><span>(</span><span>2414</span><span>)</span>

headers = {

<span>&nbsp; </span><span>'Authorization'</span><span>: </span><span>f</span><span>"Basic </span><span>{</span><span>creds</span><span>}</span><span>"</span><span>,</span>

  'Accept': 'application/json'

}

<span>requests</span><span> </span><span>=</span><span> </span><span>request_manager</span><span>.</span><span>request_manager</span><span>(</span><span>base_url</span><span>=</span><span>base_url</span><span>, </span><span>headers</span><span>=</span><span>headers</span><span>)</span>

# Build SWQL query

<span>query</span><span> </span><span>=</span><span> [</span><span>'SELECT TOP 10 I.EntityID, I.ChassisType, I.ChassisName, I.ChassisVersion, I.ChassisID, I.ChassisSerialNumberString, I.FirstDiscovery'</span><span>]</span>

<span>query</span><span> </span><span>=</span><span> </span><span>","</span><span>.</span><span>join</span><span>(</span><span>query</span><span>)</span>

# Make API request and display results

<span>endpoint</span><span> </span><span>=</span><span> </span><span>f</span><span>"Query?query=</span><span>{</span><span>query</span><span>}</span><span> FROM NCM.CiscoChassis I"</span>

<span>r</span><span> </span><span>=</span><span> </span><span>requests</span><span>.</span><span>request</span><span>(</span><span>endpoint</span><span>=</span>

endpoint, method = 'GET')

<span>print</span><span>(</span><span>json</span><span>.</span><span>dumps</span><span>(</span><span>r</span><span>.</span><span>json</span><span>(), </span><span>indent</span><span>=</span><span>4</span><span>))</span>

</code></div><div><code>#Returns empty string

{
"results": []
}

Using the same python API logic to make calls to Orion.{endpoint} works fine. The python code is basically the same as the orionsdk -- it's just a wrapper for the API using the request lib on the backend.

Find more posts tagged with

orionsdk

swql_studio

Accepted answers

Chetim

Ugh.. It was a permission issue. So even though I could run the SWQL queries in SWQL Studio fine, running them in the API requires at least "WebViewer" permissions in "Network Configuration Manager Settings" under Admin > Accounts > Edit Account.

All comments

Chetim

A query also fails when requesting an NCM resource linked to an Orion resource. My first thought is a permissions issue, but if that's the case I wouldn't expect the same query ran in SWQL Studio to work.

This query fails because NodeProperties is a resource from NCM.

endpoint = f

"""Query?query=

<span>SELECT I.NodeID, <strong>I.NodeProperties.CiscoChassis.ChassisID</strong>, I.SwitchStack.SwitchStackMember.DisplayName, I.SwitchStack.SwitchStackMember.SerialNumber, I.SwitchStack.MemberCount, I.SwitchStack.SwitchStackMember.Uri</span>

FROM Orion.Nodes I

WHERE I.Uri = '{'swinds_node_uri'}'

""" 

adam.beedell

You havnt got a FROM in the python unless i'm missing something. Possible copypasta issue?

Chetim

I should have simplified that code example, but the 'FROM' statement exists in the endpoint which is eventually appended to the URL. The query ends up looking like this:

https://solarwinds:17778/SolarWinds/InformationService/v3/Json/Query?query=SELECT TOP 10 I.EntityID, I.ChassisType, I.ChassisName, I.ChassisVersion, I.ChassisID, I.ChassisSerialNumberString, I.FirstDiscovery FROM NCM.CiscoChassis I

 

adam.beedell

Aah interesting. Just checking again, but the WHERE is definitely resolving correctly too? Looks like a macro/variable/etc but not sure if it's resolving with singlequotes around it, which it'll probably need

Chetim