/v2/projects/{project_id}/open¶
POST /v2/projects/{project_id}/open¶
Open a project
Parameters¶
project_id: Project UUID
Response status codes¶
201: The project has been opened
404: The project doesn’t exist
Output¶
| 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 | |
| drawing_grid_size | integer | Grid size for the drawing area for drawings | |
| filename | ['string', 'null'] | Project filename | |
| grid_size | integer | Grid size for the drawing area for nodes | |
| 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 | |
| show_grid | boolean | Show the grid on the drawing area | |
| show_interface_labels | boolean | Show interface labels on the drawing area | |
| show_layers | boolean | Show layers on the drawing area | |
| snap_to_grid | boolean | Snap to grid on the drawing area | |
| status | enum | Possible values: opened, closed | |
| supplier | ['object', 'null'] | Supplier of the project | |
| variables | ['array', 'null'] | Variables required to run the project | |
| zoom | integer | Zoom of the drawing area |
Sample session¶
curl -i -X POST 'http://localhost:3080/v2/projects/8094bba2-62bb-48a5-ae9a-b977da5b7cb2/open' -d '{}'
POST /v2/projects/8094bba2-62bb-48a5-ae9a-b977da5b7cb2/open HTTP/1.1
{}
HTTP/1.1 201
Connection: close
Content-Length: 560
Content-Type: application/json
Date: Wed, 08 Jan 2020 02:28:01 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/projects/{project_id}/open
{
"auto_close": true,
"auto_open": false,
"auto_start": false,
"drawing_grid_size": 25,
"filename": "test.gns3",
"grid_size": 75,
"name": "test",
"path": "/tmp/tmp7b2lfg8t/projects/8094bba2-62bb-48a5-ae9a-b977da5b7cb2",
"project_id": "8094bba2-62bb-48a5-ae9a-b977da5b7cb2",
"scene_height": 1000,
"scene_width": 2000,
"show_grid": false,
"show_interface_labels": false,
"show_layers": false,
"snap_to_grid": false,
"status": "opened",
"supplier": null,
"variables": null,
"zoom": 100
}