/v2/projects/load

POST /v2/projects/load

Open a project (only local server)

Parameters

  • path: .gns3 path

Response status codes

  • 201: The project has been opened
  • 403: The server is not the local server

Input

Name Mandatory Type Description
path ✔ string .gns3 path

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 POST 'http://localhost:3080/v2/projects/load' -d '{"path": "/tmp/test.gns3"}'

POST /v2/projects/load HTTP/1.1
{
    "path": "/tmp/test.gns3"
}


HTTP/1.1 201
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/load

{
    "auto_close": true,
    "auto_open": false,
    "auto_start": false,
    "filename": "test.gns3",
    "name": "test",
    "path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpdmzj8ewe/projects/6f6fbad5-35c3-4138-82bd-42ba3d91d686",
    "project_id": "6f6fbad5-35c3-4138-82bd-42ba3d91d686",
    "scene_height": 1000,
    "scene_width": 2000,
    "status": "opened"
}