Welcome to API documentation!

Warning

This documentation are for developers for user documentation go to https://gns3.com/

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

This documentation cover the GNS3 API and ressources for GNS3 developers.

If you want a quick demo on how to use the API read: Sample session using curl

API

• General
  • Architecture
  • Communications
  • Errors
  • Limitations
  • Notifications
  • Previous versions
• Glossary
  • Node
  • Drawing
  • Adapter
  • Port
  • Controller
  • Compute
  • Symbol
  • Scene
• Sample session using curl
  • List computes
  • Create project
  • Create nodes
  • Link nodes
  • Start nodes
  • Connect to nodes
  • Stop nodes
  • Add a visual element
  • Create a Qemu node
  • Create a dynamips node
  • Notifications
  • How to found the endpoints?
• Notifications
  • Notifications endpoints
  • Available notifications
• Positions
• Endpoints
  • Controller API Endpoints
  • Compute API Endpoints

GNS3 developements

• Development
  • Code convention
  • Source code
  • Documentation
    • Build doc
  • Tests
    • Run tests
• GNS3 file formats
  • The .gns3
  • The .net
  • The .gns3p or .gns3project
  • The .gns3a or .gns3appliance