mirror of
https://github.com/GNS3/gns3-server.git
synced 2024-12-24 23:16:44 +00:00
7.0 KiB
7.0 KiB
/v2/projects
POST /v2/projects
Create a new project on the server
Response status codes
- 201: Project created
- 409: Project already created
Input
Name | Mandatory | Type | Description |
---|---|---|---|
auto_close | boolean | Project auto close | |
grid_size | integer | Grid size for the drawing area | |
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 | |
show_grid | boolean | Show the grid on the drawing area | |
show_interface_labels | boolean | Show interface labels on the drawing area | |
show_layers | boolean | Show layers on the drawing area | |
snap_to_grid | boolean | Snap to grid on the drawing area | |
supplier | ['object', 'null'] | Supplier of the project | |
variables | ['array', 'null'] | Variables required to run the project | |
zoom | integer | Zoom 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 | |
grid_size | integer | Grid size for the drawing area | |
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 | |
show_grid | boolean | Show the grid on the drawing area | |
show_interface_labels | boolean | Show interface labels on the drawing area | |
show_layers | boolean | Show layers on the drawing area | |
snap_to_grid | boolean | Snap to grid on the drawing area | |
status | enum | Possible values: opened, closed | |
supplier | ['object', 'null'] | Supplier of the project | |
variables | ['array', 'null'] | Variables required to run the project | |
zoom | integer | Zoom of the drawing area |
Sample session
../../../examples/controller_post_projects.txt
GET /v2/projects
List projects
Response status codes
- 200: List of projects
Sample session
../../../examples/controller_get_projects.txt