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

Python REST API connection to SolarWinds SAM 2024.4.1

Hi fellow IT brothers,

I posed this question a year ago on THWACK and received 2 responses. Although I appreciate all support it did not provide the guidance I needed. I must of explained it incorrectly. I will endeavor to correct this and re-write my requirement's now.

Overall project goal:

I'm in essence developing connector software using Django for a NOC center for a large IT company. I am not building new dashboards for SW's. As everyone already knows that most significant software companies today build their software with RESTFUL API Endpoints. So there is an easy way for developers to access / manage the data from many software installs based on a standard i.e.: OpenAPI there in lies the term 'connector'. Matter of fact a lot of developers are actually writing there code incorporating there own data access control panels and dashboards using their own RESTFUL API endpoints. Django as one of many python frameworks has a very robust RESTFUL API library to do such a buildout. I am not building a RESTFUL API Endpoint. I will strictly be accessing data from many software installs using API Requests.

The ability to ETL and manipulate data is the result. With this comes efficiency and inevitably money savings. Using pythons request library solves most API access requirements. When it comes to SolarWinds (specifically SAM 2024.4.1 and above) there is a lot of confusion. Should I, can I use OpenAPI standards? I have read yes and no. Should I use SWQL imbedded in python? PowerShell although good for dev and some quick changes / data capture is not useful for connector software. I see there is / was a python library for SolarWinds API access but now seems to be deprecated and unsupported. Does SW's now allow issuance of API keys at version 2024.4 + ? I found information on getting such and the directions were not accurate at all. You can see there is confusion. I just need at a minimum enough direction to get me on the page. More is always welcomed. If I cannot get needed direction from THWACK then I will need to open a ticket with SW's. I appreciate all support and guidance.

Find more posts tagged with

Accepted answers

All comments

marcrobinson

I looked at the answers to your earlier post - I agree with their sentiments. I will try to add some clarification though.

The solarwinds orion API will use basic authentication only. Please upvote this feature request for enhanced authentication when using the solarwinds orion api : SolarWinds API should support OAUTH2 and Bearer Token, and not just basic auth. - Feature Requests - The SolarWinds Platform - THWACK

Also - You will need to use swql to request the data in you api call. At least that is what I believe that you are asking. You can use Python to send the call though.
So, should you use SWQL embedded in your Python - yes.
Is the Python module still around? Yes.
- GitHub - solarwinds/orionsdk-python: Python client for interacting with the SolarWinds Orion API
- REST · solarwinds/OrionSDK Wiki · GitHub
Does the SolarWinds Orion API aloow keys/tokens/anything else? NOT YET. Please upvote. Only Basic Auth still...
Does the SolarWinds Orion API need some love - YES.
Is the API directly supported by SolarWinds - YES and NO. They support the API itself, but programming questions are not usually supported by their service desk. They may be able to point you in the correct direction. See below about success managers.

I would not expect much change in the API functionality as the real work of getting data is done by the SWQL command. There have been updates related to specific features of the some of the SolarWinds HCO/Orion/SelfHosted modules, but nothing sticks out to me as it would related to data extraction.

You can also talk to your SolarWinds Customer Success Manager to get assistance. They are able to help with these types of requests and they would be the best place to start officially. They are able to talk directly to other teams to find an answer or someone that can advise you. Your Account Rep should be able to get you into touch with yours.

Good Luck.

jbhrfx

Thank you so much for all the good information. I will upvote as u requested. I appreciate your time.

jbhrfx

What's interesting is were using SAM 2024.4.1 and in the Setting's > credentials menu it does indicate you can issue an API key to a specific user. Approval to try this is forth coming.