mirror of
https://github.com/GNS3/gns3-server
synced 2025-01-16 02:51:00 +00:00
49 lines
3.1 KiB
ReStructuredText
49 lines
3.1 KiB
ReStructuredText
|
/v1/servers
|
||
|
|
----------------------------------------------------------------------------------------------------------------------
|
||
|
|
|
||
|
|
.. contents::
|
||
|
|
|
||
|
|
POST /v1/servers
|
||
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
Register a server
|
||
|
|
|
||
|
|
Response status codes
|
||
|
|
**********************
|
||
|
|
- **201**: Server added
|
||
|
|
|
||
|
|
Input
|
||
|
|
*******
|
||
|
|
.. raw:: html
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||
|
|
<tr><td>host</td> <td>✔</td> <td>string</td> <td>Server host</td> </tr>
|
||
|
|
<tr><td>password</td> <td> </td> <td>string</td> <td>Password for auth</td> </tr>
|
||
|
|
<tr><td>port</td> <td>✔</td> <td>integer</td> <td>Server port</td> </tr>
|
||
|
|
<tr><td>protocol</td> <td>✔</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
|
||
|
|
<tr><td>server_id</td> <td>✔</td> <td>string</td> <td>Server identifier</td> </tr>
|
||
|
|
<tr><td>user</td> <td> </td> <td>string</td> <td>User for auth</td> </tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
Output
|
||
|
|
*******
|
||
|
|
.. raw:: html
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||
|
|
<tr><td>connected</td> <td> </td> <td>boolean</td> <td>True if controller is connected to the server</td> </tr>
|
||
|
|
<tr><td>host</td> <td>✔</td> <td>string</td> <td>Server host</td> </tr>
|
||
|
|
<tr><td>port</td> <td>✔</td> <td>integer</td> <td>Server port</td> </tr>
|
||
|
|
<tr><td>protocol</td> <td>✔</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
|
||
|
|
<tr><td>server_id</td> <td>✔</td> <td>string</td> <td>Server identifier</td> </tr>
|
||
|
|
<tr><td>user</td> <td> </td> <td>string</td> <td>User for auth</td> </tr>
|
||
|
|
<tr><td>version</td> <td> </td> <td>['string', 'null']</td> <td>Version of the GNS3 remote server</td> </tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
Sample session
|
||
|
|
***************
|
||
|
|
|
||
|
|
|
||
|
|
.. literalinclude:: ../../../examples/post_servers.txt
|
||
|
|
|