Welcome to API documentation!

Warning

This documentation is intended for developers. The user documentation is available on https://gns3.com/

This documentation describe the GNS3 API and provide information for GNS3 developers.

For a quick demo on how to use the API read: Sample sessions using curl

API

• General
  • Architecture
  • Communications
  • Errors
  • Limitations
  • Notifications
  • Previous versions
• Glossary
  • Project
  • Topology
  • Node
  • Template
  • Appliance
  • Drawing
  • Adapter
  • Port
  • Controller
  • Compute
  • Symbol
  • Scene
  • Filter
• Sample sessions using curl
  • Server version
  • List computes
  • Create a project
  • Create nodes
  • Link nodes
  • Start nodes
  • Connect to nodes
  • Stop nodes
  • Add visual elements
  • Add a packet filter
  • Template creation
  • Node creation
  • Controller notifications
  • Project notifications
  • Where to find the endpoints?
• Controller notifications
  • Notification endpoints
  • Available notifications
• Project notifications
  • Notification endpoints
  • Available notifications
• Positions
• Endpoints
  • Controller endpoints
  • Compute Endpoints

GNS3 development

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