gns3-server/docs/api/v1projectsprojectid.rst
Julien Duponchelle ca354ae7f2 Doc API V1
2015-02-04 10:31:31 +01:00

3.0 KiB

/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
project_id string Project UUID
temporary boolean If project is a temporary project

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
  • 404: The project 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
project_id string Project UUID
temporary boolean If project is a temporary project

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