|
|
|
|
To access the REST API, connect to the Traverse Web Application URL with the additional path as described below:
REST Command Format
<protocol>://<host>:<port>/api/rest/command/<command>?<params>
where:
<protocol> |
Either http or https, depending on how your Traverse webapp is configured. |
<host> |
Hostname or IP address for your Traverse webapp. |
<port> |
Normally not required. Use when running Traverse on a non-standard path. |
<command> |
The REST API commands. |
<params> |
Any parameters required by the <command>. |
For example:
http://traverse.my.domain/api/rest/command/login?john/mypassword
To access the WADL:
http://<host>:<port>/api/rest?_wadl&_type=xml
https://<host>:<port>/api/rest?_wadl&_type=xml
To return JSON formatted output, add the &format=json parameter to request the URL. For example:
http://traverse/api/rest/command/device.list?devicename=Traverse Server&format=json