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

/v2/projects/{project_id}

GET /v2/projects/{project_id}

Get a project

Parameters

• project_id: Project UUID

Response status codes

• 200: Project information returned
• 404: The project doesn't exist

Sample session

../../../examples/controller_get_projectsprojectid.txt

PUT /v2/projects/{project_id}

Update a project instance

Response status codes

• 200: Node updated
• 400: Invalid request
• 404: Instance doesn't exist

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
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

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
status		enum	Possible values: opened, closed

Sample session

../../../examples/controller_put_projectsprojectid.txt

DELETE /v2/projects/{project_id}

Delete a project from disk

Parameters

• project_id: Project UUID

Response status codes

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

Sample session

../../../examples/controller_delete_projectsprojectid.txt