SolarWinds Orion

this readme file provides information and instructions on how to use the solarwinds connector, which allows you to retrieve information from solarwinds using swql queries the solarwinds connector allows you to retrieve data from solarwinds using swql queries with this connector, you can easily get solarwinds data into your turbine instance requirements to use the solarwinds connector integration, you will need access to a solarwinds instance knowledge of swql queries for more information, see the official solarwinds documentation a api token for the solarwinds instance capabilities the solarwinds connector provides the following capabilities get query (swql) retrieve alert list retrieve event list configurations http bearer authentication authenticates using bearer token configuration parameters parameter description type required url a url to the target host ie " https //localhost 17778 https //localhost 17778 " string required token the api token string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions get query (swql) use solarwinds query language (swql) to query your solarwinds orion platform for specific information endpoint url /solarwinds/informationservice/v3/json/query method get input argument name type required description query string optional parameter for get query (swql) headers object optional http headers for the request user agent string optional parameter for get query (swql) host string optional parameter for get query (swql) accept string optional parameter for get query (swql) content type string optional type of the resource content length string optional response content output parameter type description status code number http status code of the response reason string response reason phrase headers object http headers for the request response object output field response totalrows number output field totalrows results array result of the operation uri string output field uri example \[ { "status code" 200, "reason" "ok", "headers" null, "response" { "totalrows" 13, "results" \[] } } ] retrieve alert list retrieves a list of alerts based on the filter values provided in the command arguments endpoint url /solarwinds/informationservice/v3/json/query method get input argument name type required description alert id array optional a comma separated list of alert ids type array optional a comma separated list of the type of property to monitor for example node, ipam iprequests, orion discoverylogs, apm component, ipam networks, orion nodesforecastcapacity, apm application, orion volumesforecastcapacity, orion nodesforecastcapacity, etc severity array optional a comma separated list of severity levels possible values are information, warning, critical, serious, and notice sort key string optional key by which the response will be sorted for example alertid, alertactiveid, alertobjectid, triggereddatetime, triggeredmessage, acknowledgeddatetime, engineid, name, objecttype, etc default is alertactiveid sort order string optional order by which the response will be sorted possible values are ascending and descending default is ascending page number optional the page number from which to retrieve alerts by default, the per page limit is 50 alerts you can change change this value in the limit argument default is 0 limit number optional the number of records to be retrieved default is 50 output parameter type description status code number http status code of the response reason string response reason phrase solarwinds object output field solarwinds alert array output field alert alertactiveid number unique identifier alertid number unique identifier alertmessage string response message alertobjectid number unique identifier alertrefid string unique identifier canned boolean output field canned configurationdescription string output field configurationdescription context string output field context enabled boolean output field enabled entitycaption string output field entitycaption entitynetobjectid string unique identifier entitytype string type of the resource entityuri string output field entityuri frequency number output field frequency instancesiteid number unique identifier instancetype string type of the resource lastedit string output field lastedit lasttriggereddatetime string time value name string name of the resource notifyenabled boolean output field notifyenabled objecttype string type of the resource example \[ { "status code" 200, "response headers" { "content length" "140", "content type" "application/json", "date" "tue, 19 dec 2023 20 37 23 gmt" }, "reason" "ok", "json body" { "solarwinds" {} } } ] retrieve event list retrieves a list of events on the filter values provided in the command arguments endpoint url /solarwinds/informationservice/v3/json/query method get input argument name type required description acknowledged boolean optional whether to retrieve events that are acknowledged if true, then retrieves all acknowledged events possible values are true and false event id array optional a comma separated ist of event ids event type array optional a comma separated list of event types for example warning, informational, node up, etc node array optional to retrieve events of specific nodes sort key string optional key by which the response will be sorted for example eventid, eventtime, message, timestamp, eventtypename, node, etc default is eventid sort order string optional order by which the response will be sorted possible values are ascending and descending default is ascending page number optional the page number from which retrieve events by default, the per page limit is 50 events you can change this value in the limit argument default is 0 limit number optional the maximum number of records to be retrieved default is 50 output parameter type description status code number http status code of the response reason string response reason phrase solarwinds object output field solarwinds event array output field event acknowledged boolean output field acknowledged engineid number unique identifier eventid number unique identifier eventtime string time value eventtype number type of the resource eventtypename string name of the resource instancesiteid number unique identifier instancetype string type of the resource message string response message netobjectid number unique identifier netobjecttype string type of the resource networknode number output field networknode node string output field node timestamp array output field timestamp uri string output field uri example \[ { "status code" 200, "response headers" { "content length" "140", "content type" "application/json", "date" "tue, 19 dec 2023 20 37 23 gmt" }, "reason" "ok", "json body" { "solarwinds" {} } } ] response headers header description example content length the length of the response body in bytes 140 content type the media type of the resource application/json date the date and time at which the message was originated tue, 19 dec 2023 20 37 23 gmt notes solarwinds documentation https //documentation solarwinds com/en/success center/sam/content/sam api poller methods htm