1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-04 22:28:12 +00:00
gns3-server/docs/api/v2/controller/server/version.rst
Julien Duponchelle 73c31b4b87
Update docs
2017-03-21 13:32:04 +01:00

66 lines
2.6 KiB
ReStructuredText

/v2/version
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Retrieve the server version number
Response status codes
**********************
- **200**: OK
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>local</td> <td> </td> <td>boolean</td> <td>Whether this is a local server or not</td> </tr>
<tr><td>version</td> <td>&#10004;</td> <td>string</td> <td>Version number</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_version.txt
POST /v2/version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Check if version is the same as the server
Response status codes
**********************
- **200**: Same version
- **409**: Invalid version
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>local</td> <td> </td> <td>boolean</td> <td>Whether this is a local server or not</td> </tr>
<tr><td>version</td> <td>&#10004;</td> <td>string</td> <td>Version number</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>local</td> <td> </td> <td>boolean</td> <td>Whether this is a local server or not</td> </tr>
<tr><td>version</td> <td>&#10004;</td> <td>string</td> <td>Version number</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_version.txt