Ask the Community
Groups
Traverse Web Services - Current, Legacy and Deprecated - Connect IT Community | Kaseya
<main> <article class="userContent"> <p><strong>QUESTION<br></strong>What are the various Trvaerse web services?</p> <p><strong>RESOLUTION</strong><br>To review the list of available Web Services endpoints, navigate to <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Ftraverse_ip%2Fapi">https://traverse_ip/api</a>, replacing 'traverse_ip' with the actual IP address or domain name of the Traverse Web Application. There are 3 different versions of Web Services grouped under the headings:</p> <ol><li>Services</li> <li>Legacy Services</li> <li>Legacy Services - Deprecated</li> </ol><p>We recommend using the latest version, or (1) in the above list, however Engineering has indicated that Legacy Services (2) is also fully supported but might be deprecated in a future release. 'Legacy Services - Deprecated' (3) will eventually be removed and should not be used. </p> <p>Note that the Web Application also uses many of the Web Services endpoints (1) and that most web service requests/responses are recorded in $TRAVERSE_HOME\logs\service.log in JSON format, where $TRAVERSE_HOME is the installation folder on the server with the Web Application.</p> <p>Below is a sample SOAP request using the login operation (<a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Ftraverse%2Fapi%2Fsoap%2Flogin%2Flogin%29">https://traverse/api/soap/login/login)</a> to authenticate with Traverse:</p> <div> <pre class="code codeBlock" spellcheck="false" tabindex="0"><soapenv:Envelope xmlns:soapenv="<a href="/home/leaving?allowTrusted=1&target=http%3A%2F%2Fschemas.xmlsoap.org%2Fsoap%2Fenvelope%2F">http://schemas.xmlsoap.org/soap/envelope/</a>" xmlns:log="<a href="/home/leaving?allowTrusted=1&target=http%3A%2F%2Ftraverse.zyrion.com%2F05%2F06%2Flogin">http://traverse.zyrion.com/05/06/login</a>"> <soapenv:Header/> <soapenv:Body> <log:login> <loginRequest> <!--Optional:--> <password>my_password</password> <!--Optional:--> <username>my_user</username> </loginRequest> </log:login> </soapenv:Body> </soapenv:Envelope> </pre> </div> <p>The response contains information about the user's account and a session ID upon successfully authenticating:</p> <div> <pre class="code codeBlock" spellcheck="false" tabindex="0"><soap:Envelope xmlns:soap="<a href="/home/leaving?allowTrusted=1&target=http%3A%2F%2Fschemas.xmlsoap.org%2Fsoap%2Fenvelope%2F">http://schemas.xmlsoap.org/soap/envelope/</a>"> <soap:Body> <ns1:loginResponse xmlns:ns1="<a href="/home/leaving?allowTrusted=1&target=http%3A%2F%2Ftraverse.zyrion.com%2F05%2F06%2Flogin">http://traverse.zyrion.com/05/06/login</a>"> <loginResponse> <success>true</success> <timestamp>1438027917937</timestamp> <timestampStr>Monday, July 27, 2015 1:11:57 PM PDT</timestampStr> <result> <adminUser>true</adminUser> <department>SuperUsers</department> <filterEnabled>true</filterEnabled> <firstName>kaseya</firstName> <lastName>support</lastName> <permissions> <category>device</category> <createPermission>true</createPermission> <deletePermission>true</deletePermission> <readPermission>true</readPermission> <resumePermission>false</resumePermission> <suspendPermission>true</suspendPermission> <updatePermission>true</updatePermission> </permissions> <permissions> <category>test</category> <createPermission>true</createPermission> <deletePermission>true</deletePermission> <readPermission>true</readPermission> <resumePermission>false</resumePermission> <suspendPermission>true</suspendPermission> <updatePermission>true</updatePermission> </permissions> <permissions> <category>action</category> <createPermission>true</createPermission> <deletePermission>true</deletePermission> <readPermission>true</readPermission> <resumePermission>false</resumePermission> <suspendPermission>true</suspendPermission> <updatePermission>true</updatePermission> </permissions> <permissions> <category>container</category> <createPermission>true</createPermission> <deletePermission>true</deletePermission> <readPermission>true</readPermission> <resumePermission>false</resumePermission> <suspendPermission>true</suspendPermission> <updatePermission>true</updatePermission> </permissions> <permissions> <category>report</category> <createPermission>true</createPermission> <deletePermission>true</deletePermission> <readPermission>true</readPermission> <resumePermission>false</resumePermission> <suspendPermission>true</suspendPermission> <updatePermission>true</updatePermission> </permissions> <permissions> <category>map</category> <createPermission>true</createPermission> <deletePermission>true</deletePermission> <readPermission>true</readPermission> <resumePermission>false</resumePermission> <suspendPermission>true</suspendPermission> <updatePermission>true</updatePermission> </permissions> <permissions> <category>configmgmt</category> <createPermission>true</createPermission> <deletePermission>true</deletePermission> <readPermission>true</readPermission> <resumePermission>false</resumePermission> <suspendPermission>true</suspendPermission> <updatePermission>true</updatePermission> </permissions> <permissions> <category>cloud</category> <createPermission>true</createPermission> <deletePermission>true</deletePermission> <readPermission>true</readPermission> <resumePermission>false</resumePermission> <suspendPermission>true</suspendPermission> <updatePermission>true</updatePermission> </permissions> <permissions> <category>account</category> <createPermission>true</createPermission> <deletePermission>true</deletePermission> <readPermission>true</readPermission> <resumePermission>false</resumePermission> <suspendPermission>true</suspendPermission> <updatePermission>true</updatePermission> </permissions> <permissions> <category>user</category> <createPermission>true</createPermission> <deletePermission>true</deletePermission> <readPermission>true</readPermission> <resumePermission>false</resumePermission> <suspendPermission>true</suspendPermission> <updatePermission>true</updatePermission> </permissions> <permissions> <category>serviceclass</category> <createPermission>true</createPermission> <deletePermission>true</deletePermission> <readPermission>true</readPermission> <resumePermission>false</resumePermission> <suspendPermission>true</suspendPermission> <updatePermission>true</updatePermission> </permissions> <permissions> <category>limit</category> <createPermission>true</createPermission> <deletePermission>true</deletePermission> <readPermission>true</readPermission> <resumePermission>false</resumePermission> <suspendPermission>true</suspendPermission> <updatePermission>true</updatePermission> </permissions> <refreshInterval>180</refreshInterval> <sessionId>BC4A6E1AD7ED0351DE1703E9693D01D9</sessionId> </result> </loginResponse> </ns1:loginResponse> </soap:Body> </soap:Envelope> </pre> </div> <p>The session ID may then be used to initiate other queries, for example to obtain a list of all devices with the SOAP 'device/getStatuses' operation (<a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Ftraverse%2Fapi%2Fsoap%2Fdevice%2FgetStatuses%29">https://traverse/api/soap/device/getStatuses)</a></p> <div> <pre class="code codeBlock" spellcheck="false" tabindex="0"> <soapenv:Envelope xmlns:soapenv="<a href="/home/leaving?allowTrusted=1&target=http%3A%2F%2Fschemas.xmlsoap.org%2Fsoap%2Fenvelope%2F">http://schemas.xmlsoap.org/soap/envelope/</a>" xmlns:dev="<a href="/home/leaving?allowTrusted=1&target=http%3A%2F%2Ftraverse.zyrion.com%2F05%2F06%2Fdevice">http://traverse.zyrion.com/05/06/device</a>"> <soapenv:Header/> <soapenv:Body> <dev:getStatuses> <deviceStatusesRequest> <sessionId>BC4A6E1AD7ED0351DE1703E9693D01D9</sessionId> </deviceStatusesRequest> </dev:getStatuses> </soapenv:Body> </soapenv:Envelope> </pre> </div> <p>It is also possible to specify user credentials (username and password) with most Web Services operations, instead of using a session ID. For example:</p> <div> <pre class="code codeBlock" spellcheck="false" tabindex="0"> <soapenv:Envelope <soapenv:Envelope xmlns:soapenv="<a href="/home/leaving?allowTrusted=1&target=http%3A%2F%2Fschemas.xmlsoap.org%2Fsoap%2Fenvelope%2F">http://schemas.xmlsoap.org/soap/envelope/</a>" xmlns:dev="<a href="/home/leaving?allowTrusted=1&target=http%3A%2F%2Ftraverse.zyrion.com%2F05%2F06%2Fdevice">http://traverse.zyrion.com/05/06/device</a>"> <soapenv:Header/> <soapenv:Body> <dev:getStatuses> <deviceStatusesRequest> <password>my_password</password> <username>my_user</username> </deviceStatusesRequest> </dev:getStatuses> </soapenv:Body> </soapenv:Envelope> </pre> </div> <p> <br><strong>APPLIES TO</strong><br>All Traverse versions</p> <p><strong>REFERENCE<br>-</strong></p> <p><strong>REFERENCE</strong></p> </article> </main>