gns3-server/docs/api/projectuuid.rst
2015-01-23 16:21:26 +01:00

3.1 KiB

/project/{uuid}

GET /project/{uuid}

Get project informations

Parameters

  • uuid: Project instance UUID

Response status codes

  • 200: OK
  • 404: Project instance doesn't exist

Output

Name Mandatory Type Description
location string Base directory where the project should be created on remote server
temporary boolean If project is a temporary project
uuid string Project UUID

Sample session

examples/get_projectuuid.txt

PUT /project/{uuid}

Update a project

Parameters

  • uuid: Project instance UUID

Response status codes

  • 200: Project updated
  • 404: Project instance doesn't exist

Input

Name Mandatory Type Description
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
temporary boolean If project is a temporary project
uuid string Project UUID

Sample session

examples/put_projectuuid.txt

DELETE /project/{uuid}

Delete a project from disk

Parameters

  • uuid: Project instance UUID

Response status codes

  • 404: Project instance doesn't exist
  • 204: Changes write on disk

Sample session

examples/delete_projectuuid.txt