/v2/projects/load
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/load
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Open a project (only local server)
Parameters
**********
- **path**: .gns3 path
Response status codes
**********************
- **201**: The project has been opened
- **403**: The server is not the local server
Input
*******
.. raw:: html
Name | Mandatory | Type | Description |
path | ✔ | string | .gns3 path |
Output
*******
.. raw:: html
Name | Mandatory | Type | Description |
auto_close | | boolean | Project auto close when client cut off the notifications feed |
auto_open | | boolean | Project open when GNS3 start |
auto_start | | boolean | Project start when opened |
filename | | ['string', 'null'] | Project filename |
name | | ['string', 'null'] | Project name |
path | | ['string', 'null'] | Project directory |
project_id | ✔ | string | Project UUID |
scene_height | | integer | Height of the drawing area |
scene_width | | integer | Width of the drawing area |
status | | enum | Possible values: opened, closed |
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsload.txt