gns3-server/docs/api/v1/project/projectsprojectid.rst

/v1/projects/{project_id}

GET /v1/projects/{project_id}

Get project information

Parameters

• project_id: The UUID of the project

Response status codes

• 200: Success
• 404: The project doesn't exist

Output

Name	Mandatory	Type	Description
location	✔	string	Base directory where the project should be created on remote server
name		string	Project name
path		string	Directory of the project on the server
project_id	✔	string	Project UUID
temporary	✔	boolean	If project is a temporary project

Sample session

../../examples/get_projectsprojectid.txt

PUT /v1/projects/{project_id}

Update a project

Parameters

• project_id: The UUID of the project

Response status codes

• 200: The project has been updated
• 403: You are not allowed to modify this property
• 404: The project doesn't exist

Input

Name	Mandatory	Type	Description
name		['string', 'null']	Project name
path		['string', 'null']	Path of the project on the server (work only with --local)
temporary		boolean	If project is a temporary project

Output

Name	Mandatory	Type	Description
location	✔	string	Base directory where the project should be created on remote server
name		string	Project name
path		string	Directory of the project on the server
project_id	✔	string	Project UUID
temporary	✔	boolean	If project is a temporary project

Sample session

../../examples/put_projectsprojectid.txt

DELETE /v1/projects/{project_id}

Delete a project from disk

Parameters

• project_id: The UUID of the project

Response status codes

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

Sample session

../../examples/delete_projectsprojectid.txt