Welcome to API documentation!

Warning

The API is not stable, feel free to post comments on our website https://gns3.com/

• Communications
• Errors
• Sample session using curl
• Limitations
  • Concurrency
  • Authentication
• Notifications
• Glossary
  • VM
  • Adapter
  • Port
• Development
  • Code convention
  • Documentation
    • Build doc
  • Tests
    • Run tests

API Endpoints

• Config
  • /v1/config/reload
• Docker
  • /v1/docker/images
  • /v1/projects/{project_id}/docker/images
  • /v1/projects/{project_id}/docker/images/{id}
  • /v1/projects/{project_id}/docker/images/{id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/nio
  • /v1/projects/{project_id}/docker/images/{id}/reload
  • /v1/projects/{project_id}/docker/images/{id}/start
  • /v1/projects/{project_id}/docker/images/{id}/stop
  • /v1/projects/{project_id}/docker/images/{id}/suspend
• Dynamips device
  • /v1/projects/{project_id}/dynamips/devices
  • /v1/projects/{project_id}/dynamips/devices/{device_id}
  • /v1/projects/{project_id}/dynamips/devices/{device_id}/ports/{port_number:d+}/nio
  • /v1/projects/{project_id}/dynamips/devices/{device_id}/ports/{port_number:d+}/start_capture
  • /v1/projects/{project_id}/dynamips/devices/{device_id}/ports/{port_number:d+}/stop_capture
• Dynamips vm
  • /v1/dynamips/vms
  • /v1/dynamips/vms/{path}
  • /v1/projects/{project_id}/dynamips/vms
  • /v1/projects/{project_id}/dynamips/vms/{vm_id}
  • /v1/projects/{project_id}/dynamips/vms/{vm_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/nio
  • /v1/projects/{project_id}/dynamips/vms/{vm_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/start_capture
  • /v1/projects/{project_id}/dynamips/vms/{vm_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/stop_capture
  • /v1/projects/{project_id}/dynamips/vms/{vm_id}/auto_idlepc
  • /v1/projects/{project_id}/dynamips/vms/{vm_id}/configs
  • /v1/projects/{project_id}/dynamips/vms/{vm_id}/configs/save
  • /v1/projects/{project_id}/dynamips/vms/{vm_id}/idlepc_proposals
  • /v1/projects/{project_id}/dynamips/vms/{vm_id}/reload
  • /v1/projects/{project_id}/dynamips/vms/{vm_id}/resume
  • /v1/projects/{project_id}/dynamips/vms/{vm_id}/start
  • /v1/projects/{project_id}/dynamips/vms/{vm_id}/stop
  • /v1/projects/{project_id}/dynamips/vms/{vm_id}/suspend
• File
  • /v1/files/stream
• Iou
  • /v1/iou/vms
  • /v1/iou/vms/{path}
  • /v1/projects/{project_id}/iou/vms
  • /v1/projects/{project_id}/iou/vms/{vm_id}
  • /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/nio
  • /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/start_capture
  • /v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/stop_capture
  • /v1/projects/{project_id}/iou/vms/{vm_id}/configs
  • /v1/projects/{project_id}/iou/vms/{vm_id}/configs/save
  • /v1/projects/{project_id}/iou/vms/{vm_id}/reload
  • /v1/projects/{project_id}/iou/vms/{vm_id}/start
  • /v1/projects/{project_id}/iou/vms/{vm_id}/stop
• Network
  • /v1/interfaces
  • /v1/projects/{project_id}/ports/udp
• Project
  • /v1/projects
  • /v1/projects/{project_id}
  • /v1/projects/{project_id}/close
  • /v1/projects/{project_id}/commit
  • /v1/projects/{project_id}/files
  • /v1/projects/{project_id}/files/{path:.+}
  • /v1/projects/{project_id}/notifications
• Qemu
  • /v1/projects/{project_id}/qemu/vms
  • /v1/projects/{project_id}/qemu/vms/{vm_id}
  • /v1/projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/nio
  • /v1/projects/{project_id}/qemu/vms/{vm_id}/reload
  • /v1/projects/{project_id}/qemu/vms/{vm_id}/resume
  • /v1/projects/{project_id}/qemu/vms/{vm_id}/start
  • /v1/projects/{project_id}/qemu/vms/{vm_id}/stop
  • /v1/projects/{project_id}/qemu/vms/{vm_id}/suspend
  • /v1/qemu/binaries
  • /v1/qemu/capabilities
  • /v1/qemu/img
  • /v1/qemu/img-binaries
  • /v1/qemu/vms
  • /v1/qemu/vms/{path:.+}
• Server
  • /v1/server/shutdown
• Version
  • /v1/version
• Virtualbox
  • /v1/projects/{project_id}/virtualbox/vms
  • /v1/projects/{project_id}/virtualbox/vms/{vm_id}
  • /v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/nio
  • /v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/start_capture
  • /v1/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/stop_capture
  • /v1/projects/{project_id}/virtualbox/vms/{vm_id}/reload
  • /v1/projects/{project_id}/virtualbox/vms/{vm_id}/resume
  • /v1/projects/{project_id}/virtualbox/vms/{vm_id}/start
  • /v1/projects/{project_id}/virtualbox/vms/{vm_id}/stop
  • /v1/projects/{project_id}/virtualbox/vms/{vm_id}/suspend
  • /v1/virtualbox/vms
• Vmware
  • /v1/projects/{project_id}/vmware/vms
  • /v1/projects/{project_id}/vmware/vms/{vm_id}
  • /v1/projects/{project_id}/vmware/vms/{vm_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/nio
  • /v1/projects/{project_id}/vmware/vms/{vm_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/start_capture
  • /v1/projects/{project_id}/vmware/vms/{vm_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/stop_capture
  • /v1/projects/{project_id}/vmware/vms/{vm_id}/interfaces/vmnet
  • /v1/projects/{project_id}/vmware/vms/{vm_id}/reload
  • /v1/projects/{project_id}/vmware/vms/{vm_id}/resume
  • /v1/projects/{project_id}/vmware/vms/{vm_id}/start
  • /v1/projects/{project_id}/vmware/vms/{vm_id}/stop
  • /v1/projects/{project_id}/vmware/vms/{vm_id}/suspend
  • /v1/vmware/vms
• Vpcs
  • /v1/projects/{project_id}/vpcs/vms
  • /v1/projects/{project_id}/vpcs/vms/{vm_id}
  • /v1/projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/nio
  • /v1/projects/{project_id}/vpcs/vms/{vm_id}/reload
  • /v1/projects/{project_id}/vpcs/vms/{vm_id}/start
  • /v1/projects/{project_id}/vpcs/vms/{vm_id}/stop