NgTech-LTD/gns3-server
2
0 Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2026-11-03 05:51:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update API documentation

Browse Source
This commit is contained in:
Bernhard Ehlers committed 2018-06-07 10:26:06 +02:00
1 parent 62f87de23a
commit 60a3ab87dc
226 files changed
+2983 -840
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/compute/docker/projectsprojectiddockernodes.rst
+2
View File
@@ -32,6 +32,7 @@ Input
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc, http, https</td> </tr>
<tr><td>container_id</td> <td> </td> <td>string</td> <td>Docker container ID Read only</td> </tr>
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment variables</td> </tr>
<tr><td>extra_hosts</td> <td> </td> <td>['string', 'null']</td> <td>Docker extra hosts (added to /etc/hosts)</td> </tr>
<tr><td>image</td> <td>&#10004;</td> <td>string</td> <td>Docker image name</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
@@ -54,6 +55,7 @@ Output
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc, http, https</td> </tr>
<tr><td>container_id</td> <td> </td> <td>string</td> <td>Docker container ID Read only</td> </tr>
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>extra_hosts</td> <td> </td> <td>['string', 'null']</td> <td>Docker extra hosts (added to /etc/hosts)</td> </tr>
<tr><td>image</td> <td> </td> <td>string</td> <td>Docker image name Read only</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>string</td> <td>Path to the node working directory Read only</td> </tr>
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeid.rst
+2
View File
@@ -50,6 +50,7 @@ Input
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc, http, https</td> </tr>
<tr><td>container_id</td> <td> </td> <td>string</td> <td>Docker container ID Read only</td> </tr>
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>extra_hosts</td> <td> </td> <td>['string', 'null']</td> <td>Docker extra hosts (added to /etc/hosts)</td> </tr>
<tr><td>image</td> <td> </td> <td>string</td> <td>Docker image name Read only</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>string</td> <td>Path to the node working directory Read only</td> </tr>
@@ -75,6 +76,7 @@ Output
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc, http, https</td> </tr>
<tr><td>container_id</td> <td> </td> <td>string</td> <td>Docker container ID Read only</td> </tr>
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>extra_hosts</td> <td> </td> <td>['string', 'null']</td> <td>Docker extra hosts (added to /etc/hosts)</td> </tr>
<tr><td>image</td> <td> </td> <td>string</td> <td>Docker image name Read only</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>string</td> <td>Path to the node working directory Read only</td> </tr>
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidsuspend.rst
+20
View File
@@ -0,0 +1,20 @@
/v2/compute/projects/{project_id}/docker/nodes/{node_id}/suspend
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/docker/nodes/**{node_id}**/suspend
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Suspend a Docker container
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist