Are there any Rest APIs for Orion?

damon_2021

I am trying to find an API guide, and I am getting a lot of links to a dead pages and a mixture of Orion SDK, SWIS, SWQL etc ...

I would like to know if there is an api page where I can see all the APIs I can consume for my tool. For example: https://<Orion_iP>/api or /swagger> ...

I currently have an old tool that uses SolarWinds SDK and SWIS commands to download all switch configuration files. It then does a keyword lookup on the downloaded files to search. I would like to change it and build proper APIs to search switch configs directly from Orion (hopefully via API and not DB query). Is this possible? If so, please provide the api page.

If we are stuck using the SDK, is there a better way to search configs live instead of downloading?

Thanks,

Find more posts tagged with

orion

SWQL

API

orion sdk

Accepted answers

All comments

vinay.by

SolarWinds Information Service schema | Orion SDK Schemas

damon_2021

Thanks @vinay.by. For configs, I see this API:

/Invoke/Cirrus.ConfigArchive/DownloadConfig

I have a couple of questions. Is Cirrus a model that we need to install on Orion? Previously, I had been using NCM for configs, see below:

# Get latest configs from the database

conf_query = swis.query('SELECT ca.NodeID, ca.DownloadTime, ca.Config, 
ca.NodeProperties.Nodes.sysName FROM NCM.ConfigArchive 
ca INNER JOIN (SELECT NodeID, MAX(DownloadTime) AS LatestDownloadTime 
FROM NCM.ConfigArchive GROUP BY NodeID) cam ON cam.NodeID = ca.NodeID 
AND cam.LatestDownloadTime = ca.DownloadTime ORDER BY ca.NodeID')

Before I go deep into the API setup, can I achieve this from the above API? Also, why are all the API calls POST and not GET?

Last question, how do I test it via swagger. My company Orion page is like this "">https://mycompanysorion.com"

I tried below and none works:

https://mycompanysorion.com:17774/SolarWinds/InformationService/v3/Json

https://mycompanysorion.com/SolarWinds/InformationService/v3/Json

https://mycompanysorion.com/InformationService/v3/Json

and so on ...

What is the proper format?

Seashore

Cirrus is the old name of NCM (Like Orion is no longer called Orion and SAM not called APM anymore....)

Here is a full path for a simple query:
YourSolarWinds:17774/.../Query

Lyphosaurus

The URLs I use in my Postman testing are like this:

{{swbase}}/SolarWinds/InformationService/v3/Json/Query

where {{swbase}} == https://myhostname:17774

I am on v 2024.4 selfhosted.

Lyphosaurus

[quote userid="283904" url="~/products/the-solarwinds-platform/f/solarwinds-sdk/104553/are-there-any-rest-apis-for-orion/328930"]Also, why are all the API calls POST and not GET?[/quote]

The reason they are all POST is because the marketing team told them to call it a ReST API, even though it's neither "representational" nor "stateful." You expected to see something like

"GET /swapi/v3/:devicename" or "PUT /swapi/v3/:devicename/:interface" with some relevant JSON body to update interface info.

That would be a representational API but you are forced to learn the entirety of the solarwinds schema instead, and use a POST wrapper around some SQL code. If this were a stateful API, you could do something like "DELETE /swapi/v3/:devicename" but again, it's only an API, not a ReST API. If the API used the suite of HTTP verbs, you could call it stateful, so that is a dead giveaway that it's not.

Lyphosaurus

Isn't this the API you are looking for? It does a search within the context of a set of devices, though.