mirror of
https://github.com/GNS3/gns3-server
synced 2024-12-29 10:18:10 +00:00
113 lines
8.4 KiB
ReStructuredText
113 lines
8.4 KiB
ReStructuredText
/v2/projects/{project_id}
|
|
------------------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
.. contents::
|
|
|
|
GET /v2/projects/**{project_id}**
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Get a project
|
|
|
|
Parameters
|
|
**********
|
|
- **project_id**: Project UUID
|
|
|
|
Response status codes
|
|
**********************
|
|
- **200**: Project information returned
|
|
- **404**: The project doesn't exist
|
|
|
|
Sample session
|
|
***************
|
|
|
|
|
|
.. literalinclude:: ../../../examples/controller_get_projectsprojectid.txt
|
|
|
|
|
|
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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
|
|
</table>
|
|
|
|
Output
|
|
*******
|
|
.. raw:: html
|
|
|
|
<table>
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
|
<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>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>
|
|
<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>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
|
<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>
|
|
<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>
|
|
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
|
|
<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>
|
|
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
|
|
</table>
|
|
|
|
Sample session
|
|
***************
|
|
|
|
|
|
.. literalinclude:: ../../../examples/controller_put_projectsprojectid.txt
|
|
|
|
|
|
DELETE /v2/projects/**{project_id}**
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Delete a project from disk
|
|
|
|
Parameters
|
|
**********
|
|
- **project_id**: Project UUID
|
|
|
|
Response status codes
|
|
**********************
|
|
- **204**: Changes have been written on disk
|
|
- **404**: The project doesn't exist
|
|
|
|
Sample session
|
|
***************
|
|
|
|
|
|
.. literalinclude:: ../../../examples/controller_delete_projectsprojectid.txt
|
|
|