1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-12 01:58:14 +00:00
gns3-server/docs/api/v2/compute/project/projects.rst

61 lines
2.8 KiB
ReStructuredText
Raw Normal View History

2016-04-18 14:58:06 +00:00
/v2/compute/projects
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2016-06-04 08:40:39 +00:00
List all projects opened on the server
2016-04-18 14:58:06 +00:00
Response status codes
**********************
- **200**: Project list
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_projects.txt
POST /v2/compute/projects
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new project on the server
Response status codes
**********************
- **201**: Project created
2016-06-04 08:40:39 +00:00
- **403**: Forbidden to create a project
2016-04-18 14:58:06 +00:00
- **409**: Project already created
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </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', 'null']</td> <td>Project UUID</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
2016-06-17 09:12:22 +00:00
<tr><td>filename</td> <td> </td> <td>['string', 'null']</td> <td>Project filename</td> </tr>
2016-04-18 14:58:06 +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-06-17 09:12:22 +00:00
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
2016-04-18 14:58:06 +00:00
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projects.txt