/v2/compute/projects

GET /v2/compute/projects

List all projects opened on the server

Response status codes

  • 200: Project list

Sample session

curl -i -X GET 'http://localhost:3080/v2/compute/projects'

GET /v2/compute/projects HTTP/1.1



HTTP/1.1 200
Connection: close
Content-Length: 198
Content-Type: application/json
Date: Tue, 21 Mar 2017 09:31:47 GMT
Server: Python/3.6 GNS3/2.0.0dev11
X-Route: /v2/compute/projects

[
    {
        "name": "test",
        "project_id": "51010203-0405-0607-0809-0a0b0c0d0e0f"
    },
    {
        "name": "test",
        "project_id": "52010203-0405-0607-0809-0a0b0c0d0e0b"
    }
]

POST /v2/compute/projects

Create a new project on the server

Response status codes

  • 201: Project created
  • 403: Forbidden to create a project
  • 409: Project already created

Input

Name Mandatory Type Description
auto_close boolean Project auto close
name ✔ ['string', 'null'] Project name
path ['string', 'null'] Project directory
project_id ['string', 'null'] Project UUID
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 POST 'http://localhost:3080/v2/compute/projects' -d '{"name": "test", "project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f"}'

POST /v2/compute/projects HTTP/1.1
{
    "name": "test",
    "project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f"
}


HTTP/1.1 201
Connection: close
Content-Length: 80
Content-Type: application/json
Date: Tue, 21 Mar 2017 09:31:46 GMT
Server: Python/3.6 GNS3/2.0.0dev11
X-Route: /v2/compute/projects

{
    "name": "test",
    "project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f"
}