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/project/projectsprojectid.rst

113 lines
8.4 KiB
ReStructuredText
Raw Normal View History

/v2/projects/{project_id}
2016-03-11 14:21:21 +00:00
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
2016-04-18 14:49:36 +00:00
GET /v2/projects/**{project_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2016-06-04 08:40:39 +00:00
Get a project
2016-04-18 14:49:36 +00:00
Parameters
**********
2016-06-04 08:40:39 +00:00
- **project_id**: Project UUID
2016-04-18 14:49:36 +00:00
Response status codes
**********************
2016-06-04 08:40:39 +00:00
- **200**: Project information returned
2016-04-18 14:49:36 +00:00
- **404**: The project doesn't exist
2018-01-08 08:26:44 +00:00
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectid.txt
2016-04-18 14:49:36 +00:00
2016-08-15 15:39:08 +00:00
PUT /v2/projects/**{project_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a project instance
Response status codes
**********************
- **200**: Node updated
- **400**: Invalid request
- **404**: Instance doesn't exist
Input
*******
.. 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>
<tr><td>drawing_grid_size</td> <td> </td> <td>integer</td> <td>Grid size for the drawing area for drawings</td> </tr>
<tr><td>grid_size</td> <td> </td> <td>integer</td> <td>Grid size for the drawing area for nodes</td> </tr>
2016-08-15 15:39:08 +00:00
<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>Path of the project on the server (work only with --local)</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>
2018-01-08 04:57:07 +00:00
<tr><td>show_grid</td> <td> </td> <td>boolean</td> <td>Show the grid on the drawing area</td> </tr>
<tr><td>show_interface_labels</td> <td> </td> <td>boolean</td> <td>Show interface labels on the drawing area</td> </tr>
<tr><td>show_layers</td> <td> </td> <td>boolean</td> <td>Show layers on the drawing area</td> </tr>
<tr><td>snap_to_grid</td> <td> </td> <td>boolean</td> <td>Snap to grid on the drawing area</td> </tr>
2018-06-07 08:26:06 +00:00
<tr><td>supplier</td> <td> </td> <td>['object', 'null']</td> <td>Supplier of the project</td> </tr>
<tr><td>variables</td> <td> </td> <td>['array', 'null']</td> <td>Variables required to run the project</td> </tr>
2018-01-08 04:57:07 +00:00
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
2016-08-15 15:39:08 +00:00
</table>
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>
<tr><td>drawing_grid_size</td> <td> </td> <td>integer</td> <td>Grid size for the drawing area for drawings</td> </tr>
2016-08-15 15:39:08 +00:00
<tr><td>filename</td> <td> </td> <td>['string', 'null']</td> <td>Project filename</td> </tr>
<tr><td>grid_size</td> <td> </td> <td>integer</td> <td>Grid size for the drawing area for nodes</td> </tr>
2016-08-15 15:39:08 +00:00
<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>
2018-01-08 04:57:07 +00:00
<tr><td>show_grid</td> <td> </td> <td>boolean</td> <td>Show the grid on the drawing area</td> </tr>
<tr><td>show_interface_labels</td> <td> </td> <td>boolean</td> <td>Show interface labels on the drawing area</td> </tr>
<tr><td>show_layers</td> <td> </td> <td>boolean</td> <td>Show layers on the drawing area</td> </tr>
<tr><td>snap_to_grid</td> <td> </td> <td>boolean</td> <td>Snap to grid on the drawing area</td> </tr>
2016-08-15 15:39:08 +00:00
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
2018-06-07 08:26:06 +00:00
<tr><td>supplier</td> <td> </td> <td>['object', 'null']</td> <td>Supplier of the project</td> </tr>
<tr><td>variables</td> <td> </td> <td>['array', 'null']</td> <td>Variables required to run the project</td> </tr>
2018-01-08 04:57:07 +00:00
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
2016-08-15 15:39:08 +00:00
</table>
2018-01-08 08:26:44 +00:00
Sample session
***************
.. literalinclude:: ../../../examples/controller_put_projectsprojectid.txt
2016-08-15 15:39:08 +00:00
DELETE /v2/projects/**{project_id}**
2016-03-11 14:21:21 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a project from disk
Parameters
**********
2016-06-04 08:40:39 +00:00
- **project_id**: Project UUID
2016-03-11 14:21:21 +00:00
Response status codes
**********************
- **204**: Changes have been written on disk
- **404**: The project doesn't exist
2018-01-08 08:26:44 +00:00
Sample session
***************
.. literalinclude:: ../../../examples/controller_delete_projectsprojectid.txt
2017-03-21 12:32:04 +00:00