Ask the Community
Groups
Traverse Example Web Services Requests - Connect IT Community | Kaseya
<main> <article class="userContent"> <p><strong>QUESTION</strong></p> <p>How to send a request to the Traverse Web Services API?</p> <p> </p> <p><strong>RESOLUTION</strong></p> <p><strong><em>In the examples below, replace 'superuser', 'traverse' with the appropriate Traverse credentials; and replace 'localhost' with the name or IP address of a Traverse Web Application.</em></strong></p> <p>Note; 'curl' is a command generally available on *nix systems for sending HTTP requests. There is also a version available for download for Windows. </p> <p><strong># List users</strong></p> <pre class="code codeBlock" spellcheck="false" tabindex="0">curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{<br> "username":"superuser",<br> "password":"traverse"<br>}' <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Flocalhost%2Fapi%2Fjson%2Fadmin%2Fuser%2FgetCurrentUser">https://localhost/api/json/admin/user/getCurrentUser</a><br><br></pre> <p><strong># License information</strong><br><br></p> <pre class="code codeBlock" spellcheck="false" tabindex="0">curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{<br> "username":"superuser",<br> "password":"traverse"<br>}' <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Flocalhost%2Fapi%2Fjson%2Fadmin%2Fsystem%2FgetLicenses">https://localhost/api/json/admin/system/getLicenses</a><br> </pre> <p><strong># Acknowledged Events by event time</strong><br><br></p> <pre class="code codeBlock" spellcheck="false" tabindex="0">curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{ "username":"superuser", "password":"traverse", "usernameFilter":"superuser", "departmentSerialNumbers":[ ], "deviceSerialNumbers":[ ], "severities":[ ], "startTimeExp":"2-days-ago", "endTimeExp":"now" }' <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Flocalhost%2Fapi%2Fjson%2Fevent%2FgetEventAckDetails">https://localhost/api/json/event/getEventAckDetails</a></pre> <p> </p> <p><strong># Acknowledged Events for some severities by acknowledged time</strong><br><br></p> <pre class="code codeBlock" spellcheck="false" tabindex="0">curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{ "username":"traverse", "password":"traverse", "usernameFilter":"traverse", "departmentSerialNumbers":[ ], "deviceSerialNumbers":[ ], "severities":[ 524288, 8388608, 134217728 ], "startAckTimeExp":"30-days-ago", "endAckTimeExp": "now" }' <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Flocalhost%2Fapi%2Fjson%2Fevent%2FgetEventAckDetails">https://localhost/api/json/event/getEventAckDetails</a></pre> <p> </p> <p><strong># List all composite tests</strong></p> <pre class="code codeBlock" spellcheck="false" tabindex="0">curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{<br> "username":"superuser",<br> "password":"traverse",<br> "searchCriterias":[<br> {"searchOption":"TEST_TYPE",<br> "searchTerms":"composite"}<br> ],<br> "sorting":{"sortField":"testStatus",<br> "sortDirection":"DESC"}<br>}' <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Flocalhost%2Fapi%2Fjson%2Ftest%2FgetStatuses">https://localhost/api/json/test/getStatuses</a><br><br></pre> <p><strong># List all suspended tests</strong></p> <pre class="code codeBlock" spellcheck="false" tabindex="0">curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{<br> "username":"superuser",<br> "password":"traverse",<br> "searchCriterias":[<br> {"searchOption":"TEST_STATUS",<br> "searchTerms":"suspended"}<br> ]<br>}' <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Flocalhost%2Fapi%2Fjson%2Ftest%2FgetStatuses">https://localhost/api/json/test/getStatuses</a><br><br></pre> <p><strong># Current process metrics</strong></p> <pre class="code codeBlock" spellcheck="false" tabindex="0">curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{<br> "username":"superuser",<br> "password":"traverse",<br> "serialNumber":99999, <br> "metrics":["cpu","memory","disk_io"]<br>}' <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Flocalhost%2Fapi%2Fjson%2Fprocess%2FgetCurrent">https://localhost/api/json/process/getCurrent</a></pre> <p> </p> <p><strong># List all the SNMP type monitor configurations (also known as shared and local credentials), including passwords, in the department where the serial number is '49'</strong></p> <pre class="code codeBlock" spellcheck="false" tabindex="0">curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{<br> "username":"superuser",<br> "password":"traverse",<br> "showPassword":"false",<br> "searchCriterias": [<br> {"searchOption": "DEPARTMENT_SERIAL_NUMBER","searchTerms":"49"},<br> {"searchOption": "MONITORCONFIG_TYPE","searchTerms":"snmp"}]<br>}' <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Flocalhost%2Fapi%2Fjson%2Fadmin%2FmonitorConfig%2Flist">https://localhost/api/json/admin/monitorConfig/list</a></pre> <p> </p> <p><strong># List all monitor configurations without passwords/communities</strong></p> <pre class="code codeBlock" spellcheck="false" tabindex="0">curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{<br> "username":"superuser",<br> "password":"traverse",<br> "showPassword":"false"<br>}' <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Flocalhost%2Fapi%2Fjson%2Fadmin%2FmonitorConfig%2Flist">https://localhost/api/json/admin/monitorConfig/list</a></pre> <p> </p> <p><strong># List SLAs</strong></p> <pre class="code codeBlock" spellcheck="false" tabindex="0">curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{<br> "username":"traverse",<br> "password":"traverse"<br>}' <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Flocalhost%2Fapi%2Fjson%2Fsla%2FgetMeasurements">https://localhost/api/json/sla/getMeasurements</a></pre> <p> </p> <p><strong># List SLA measurements</strong></p> <pre class="code codeBlock" spellcheck="false" tabindex="0">curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{<br> "username":"traverse",<br> "password":"traverse"<br> "slaMeasurementId":"730356",<br> "granularityParam":<br> {"unit":"Day",<br> "value":1<br> },<br> "skipLastResults": 0,<br> "maxResults": 7<br>}' <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Flocalhost%2Fapi%2Fjson%2Fsla%2FgetMeasurements">https://localhost/api/json/sla/getMeasurements</a></pre> <p> </p> <p><strong># List test results</strong></p> <pre class="code codeBlock" spellcheck="false" tabindex="0">curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{<br> "username":"traverse",<br> "password":"traverse",<br> "startTime":"1514764800000",<br> "endTime":"1522540799000",<br> "searchCriterias":[<br> {"searchOption":"TEST_SERIAL_NUMBER","searchTerms":"257399"}]<br>}' <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Flocalhost%2Fapi%2Fjson%2Ftest%2FgetRawHistoricalData">https://localhost/api/json/test/getRawHistoricalData</a></pre> <p> </p> <p><strong># List current events</strong></p> <pre class="code codeBlock" spellcheck="false" tabindex="0">curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{<br> "username":"traverse",<br> "password":"traverse",<br> "startTimeExp": "1-minutes-ago",<br> "endTimeExp": "now",<br> "messageSeverities": [<br> 8388608,<br> 134217728,<br> 1073741824,<br> 16384,<br> 32768,<br> 524288,<br> 2048,<br> 8,<br> 128<br> ],<br> "sorting": {<br> "sortDirection": "DESC",<br> "sortField": "newTimestamp"<br> }<br>}' <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Flocalhost%2Fapi%2Fjson%2Fevent%2FgetMessages">https://localhost/api/json/event/getMessages</a></pre> <p> </p> <p><strong># Create a ruled based test container of tests named 'Packet Loss'</strong></p> <pre class="code codeBlock" spellcheck="false" tabindex="0">curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{<br> "username":"traverse",<br> "password":"traverse",<br> "parentContainerSerialNumber":0,<br> "containerDetail":{"name":"Packet Loss container","type":"test","comment":"","commentVisible":false,"actionProfileSerialNumber":-1,"members":null,"rules":[<br> {"searchOption":"DEVICE_NAME","searchTerms":""},<br> {"searchOption":"DEVICE_ADDRESS","searchTerms":""},<br> {"searchOption":"DEVICE_MODEL","searchTerms":""},<br> {"searchOption":"DEVICE_TYPE","searchTerms":""},<br> {"searchOption":"VENDOR_NAME","searchTerms":""},<br> {"searchOption":"TAG_1","searchTerms":""},<br> {"searchOption":"TAG_2","searchTerms":""},<br> {"searchOption":"TAG_3","searchTerms":""},<br> {"searchOption":"TAG_4","searchTerms":""},<br> {"searchOption":"TAG_5","searchTerms":""},<br> {"searchOption":"TEST_NAME","searchTerms":"Packet Loss"},<br> {"searchOption":"TEST_TYPE","searchTerms":""},<br> {"searchOption":"TEST_SUB_TYPE","searchTerms":""},<br> {"searchOption":"ELEMENT_NAME","searchTerms":""},<br> {"searchOption":"ELEMENT_CATEGORY","searchTerms":""}],<br> "severityRule":null,"useMessageEvents":false}<br>}' <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Flocalhost%2Fapi%2Fjson%2Fadmin%2Fcontainer%2Fcreate">https://localhost/api/json/admin/container/create</a></pre> <p> </p> <p><strong># List devices that are not members of a container</strong></p> <pre class="code codeBlock" spellcheck="false" tabindex="0">curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{<br> "username":"traverse",<br> "password":"traverse",<br> "includeHealth":false,<br> "includeOnlineStatus":false,<br> "searchCriterias":[<br> {"searchOption":"PARENT_CONTAINER_SERIAL_NUMBER","searchTerms":"-1"}<br> ]<br>}' <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Flocalhost%2Fapi%2Fjson%2Fdevice%2FgetStatuses">https://localhost/api/json/device/getStatuses</a></pre> <p> </p> <p><strong># List network discoveries</strong></p> <pre class="code codeBlock" spellcheck="false" tabindex="0">curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{<br> "username":"superuser",<br> "password":"traverse",<br> "searchCriterias":[],"sorting":{"sortDirection":"ASC","sortField":"sessionName"},<br> "paging":{"page":0,"limit":50}}' <br>}' <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Flocalhost%2Fapi%2Fjson%2Fdiscovery%2FgetSessions">https://localhost/api/json/discovery/getSessions</a></pre> <p> </p> <p> </p> <p><strong>APPLIES TO </strong></p> <p>Traverse version 9.1 and later.</p> <p><strong>REFERENCE </strong></p> <p>None.</p> </article> </main>