gns3-server/docs/api/v2/controller/project/projectsprojectidclose.rst
2018-01-08 09:26:44 +01:00

3.5 KiB

/v2/projects/{project_id}/close

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

../../../examples/controller_post_projectsprojectidclose.txt