/v2/projects/{project_id}/close¶
Contents
POST /v2/projects/{project_id}/close¶
Close a project
Parameters¶
- project_id: Project UUID
Response status codes¶
- 204: The project has been closed
- 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 | |
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 | |
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 | |
zoom | integer | Zoom of the drawing area |
Sample session¶
curl -i -X POST 'http://localhost:3080/v2/projects/8747d42d-da0d-4d8a-b2d6-3b569894a2ac/close' -d '{}'
POST /v2/projects/8747d42d-da0d-4d8a-b2d6-3b569894a2ac/close HTTP/1.1
{}
HTTP/1.1 201
Connection: close
Content-Length: 509
Content-Type: application/json
Date: Mon, 08 Jan 2018 08:16:39 GMT
Server: Python/3.6 GNS3/2.1.2dev1
X-Route: /v2/projects/{project_id}/close
{
"auto_close": true,
"auto_open": false,
"auto_start": false,
"filename": "test.gns3",
"name": "test",
"path": "/var/folders/qy/g6blgc5n7y93pzg61zyt7cmr0000gn/T/tmprp4q67em/projects/8747d42d-da0d-4d8a-b2d6-3b569894a2ac",
"project_id": "8747d42d-da0d-4d8a-b2d6-3b569894a2ac",
"scene_height": 1000,
"scene_width": 2000,
"show_grid": false,
"show_interface_labels": false,
"show_layers": false,
"snap_to_grid": false,
"status": "opened",
"zoom": 100
}