/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

curl -i -X GET 'http://localhost:3080/v2/projects/30013d5e-b284-4098-a12b-435d9ffdfc50'

GET /v2/projects/30013d5e-b284-4098-a12b-435d9ffdfc50 HTTP/1.1



HTTP/1.1 200
Connection: close
Content-Length: 379
Content-Type: application/json
Date: Tue, 21 Mar 2017 09:32:02 GMT
Server: Python/3.6 GNS3/2.0.0dev11
X-Route: /v2/projects/{project_id}

{
    "auto_close": true,
    "auto_open": false,
    "auto_start": false,
    "filename": "test.gns3",
    "name": "test",
    "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpoa69sgpa/projects/30013d5e-b284-4098-a12b-435d9ffdfc50",
    "project_id": "30013d5e-b284-4098-a12b-435d9ffdfc50",
    "scene_height": 1000,
    "scene_width": 2000,
    "status": "opened"
}

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

curl -i -X PUT 'http://localhost:3080/v2/projects/10010203-0405-0607-0809-0a0b0c0d0e0f' -d '{"name": "test2"}'

PUT /v2/projects/10010203-0405-0607-0809-0a0b0c0d0e0f HTTP/1.1
{
    "name": "test2"
}


HTTP/1.1 200
Connection: close
Content-Length: 380
Content-Type: application/json
Date: Tue, 21 Mar 2017 09:32:01 GMT
Server: Python/3.6 GNS3/2.0.0dev11
X-Route: /v2/projects/{project_id}

{
    "auto_close": true,
    "auto_open": false,
    "auto_start": false,
    "filename": "test.gns3",
    "name": "test2",
    "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpe4g8gdv7/projects/10010203-0405-0607-0809-0a0b0c0d0e0f",
    "project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f",
    "scene_height": 1000,
    "scene_width": 2000,
    "status": "opened"
}

DELETE /v2/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

curl -i -X DELETE 'http://localhost:3080/v2/projects/1dec0fc5-4480-403e-b86a-3c356920a828'

DELETE /v2/projects/1dec0fc5-4480-403e-b86a-3c356920a828 HTTP/1.1



HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Tue, 21 Mar 2017 09:32:02 GMT
Server: Python/3.6 GNS3/2.0.0dev11
X-Route: /v2/projects/{project_id}