/v2/projects/{project_id}/close

POST /v2/projects/{project_id}/close

Close a project

Parameters

  • project_id: Project UUID

Response status codes

  • 404: The project doesn’t exist
  • 204: The project has been closed

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
grid_size integer Grid size for the drawing area
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/588d67c3-885b-437c-ae36-ce6950830d86/close' -d '{}'

POST /v2/projects/588d67c3-885b-437c-ae36-ce6950830d86/close HTTP/1.1
{}


HTTP/1.1 201
Connection: close
Content-Length: 530
Content-Type: application/json
Date: Thu, 14 Jun 2018 08:35:16 GMT
Server: Python/3.5 GNS3/2.1.8dev1
X-Route: /v2/projects/{project_id}/close

{
    "auto_close": true,
    "auto_open": false,
    "auto_start": false,
    "filename": "test.gns3",
    "grid_size": 0,
    "name": "test",
    "path": "/tmp/tmprbo2qfxf/projects/588d67c3-885b-437c-ae36-ce6950830d86",
    "project_id": "588d67c3-885b-437c-ae36-ce6950830d86",
    "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
}