gns3-server/docs/api/v2/controller/project/projectsprojectidclose.rst

43 lines
2.6 KiB
ReStructuredText
Raw Normal View History

/v2/projects/{project_id}/close
2016-03-11 14:21:21 +00:00
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/close
2016-03-11 14:21:21 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Close a project
Parameters
**********
2016-06-04 08:40:39 +00:00
- **project_id**: Project UUID
2016-03-11 14:21:21 +00:00
Response status codes
**********************
- **404**: The project doesn't exist
- **204**: The project has been closed
2016-06-17 09:12:22 +00:00
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
2016-08-25 12:43:19 +00:00
<tr><td>auto_close</td> <td> </td> <td>boolean</td> <td>Project auto close when client cut off the notifications feed</td> </tr>
<tr><td>auto_open</td> <td> </td> <td>boolean</td> <td>Project open when GNS3 start</td> </tr>
<tr><td>auto_start</td> <td> </td> <td>boolean</td> <td>Project start when opened</td> </tr>
2016-06-17 09:12:22 +00:00
<tr><td>filename</td> <td> </td> <td>['string', 'null']</td> <td>Project filename</td> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
2016-09-27 15:15:40 +00:00
<tr><td>scene_height</td> <td> </td> <td>integer</td> <td>Height of the drawing area</td> </tr>
<tr><td>scene_width</td> <td> </td> <td>integer</td> <td>Width of the drawing area</td> </tr>
2016-06-17 09:12:22 +00:00
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
</table>
2016-03-11 16:20:09 +00:00
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidclose.txt