POST /v2/projects/{project_id}/snapshots/{snapshot_id}/restore

Restore a snapshot from disk


  • snapshot_id: Snasphot UUID
  • project_id: Project UUID

Response status codes

  • 201: The snapshot has been restored
  • 404: The project or snapshot doesn’t exist


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

curl -i -X POST 'http://localhost:3080/v2/projects/03938ba6-bad8-4cf9-825c-b3570b7a1318/snapshots/f62f4654-9547-4611-a065-e48143372958/restore' -d '{}'

POST /v2/projects/03938ba6-bad8-4cf9-825c-b3570b7a1318/snapshots/f62f4654-9547-4611-a065-e48143372958/restore HTTP/1.1

HTTP/1.1 201
Connection: close
Content-Length: 530
Content-Type: application/json
Date: Thu, 14 Jun 2018 08:35:19 GMT
Server: Python/3.5 GNS3/2.1.8dev1
X-Route: /v2/projects/{project_id}/snapshots/{snapshot_id}/restore

    "auto_close": true,
    "auto_open": false,
    "auto_start": false,
    "filename": "test.gns3",
    "grid_size": 0,
    "name": "test",
    "path": "/tmp/tmpdxyra45a/projects/03938ba6-bad8-4cf9-825c-b3570b7a1318",
    "project_id": "03938ba6-bad8-4cf9-825c-b3570b7a1318",
    "scene_height": 1000,
    "scene_width": 2000,
    "show_grid": false,
    "show_interface_labels": false,
    "show_layers": false,
    "snap_to_grid": false,
    "status": "opened",
    "supplier": null,
    "variables": null,
    "zoom": 100