gns3-server/docs/api/v2/compute/project/projectsprojectid.rst

/v2/compute/projects/{project_id}

PUT /v2/compute/projects/{project_id}

Update the project on the server

Response status codes

• 201: Project updated
• 403: Forbidden to update a project

Input

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
grid_size		integer	Grid size for the drawing area for nodes
name		['string', 'null']	Project name
path		['string', 'null']	Path of the project on the server (work only with --local)
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
supplier		['object', 'null']	Supplier of the project
variables		['array', 'null']	Variables required to run the project
zoom		integer	Zoom of the drawing area

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

../../../examples/compute_put_projectsprojectid.txt

GET /v2/compute/projects/{project_id}

Get project information

Parameters

• project_id: Project UUID

Response status codes

• 200: Success
• 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

../../../examples/compute_get_projectsprojectid.txt

DELETE /v2/compute/projects/{project_id}

Delete a project from disk

Parameters

• project_id: Project UUID

Response status codes

• 204: Changes have been written on disk
• 404: The project doesn't exist

Sample session

../../../examples/compute_delete_projectsprojectid.txt