gns3-server/docs/api/project.rst

42 lines
1.8 KiB
ReStructuredText
Raw Normal View History

2015-01-20 16:21:13 +02:00
/project
---------------------------------------------
.. contents::
POST /project
2015-01-22 11:55:11 +02:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2015-01-20 16:21:13 +02:00
Create a project on the server
Response status codes
**********************
- **200**: OK
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>location</td> <td> </td> <td>string</td> <td>Base directory where the project should be created on remote server</td> </tr>
2015-01-23 17:19:17 +02:00
<tr><td>temporary</td> <td> </td> <td>boolean</td> <td>If project is a temporary project</td> </tr>
2015-01-20 16:21:13 +02:00
<tr><td>uuid</td> <td> </td> <td>string</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>
2015-01-23 17:19:17 +02:00
<tr><td>location</td> <td>&#10004;</td> <td>string</td> <td>Base directory where the project should be created on remote server</td> </tr>
<tr><td>temporary</td> <td>&#10004;</td> <td>boolean</td> <td>If project is a temporary project</td> </tr>
<tr><td>uuid</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
2015-01-20 16:21:13 +02:00
</table>
Sample session
***************
.. literalinclude:: examples/post_project.txt