gns3-server/docs/project_notifications.rst

Project notifications

Project notifications can be received from the controller, they can be used to update projects.

Notification endpoints

Listen to the HTTP stream endpoint or to the WebSocket endpoint.

• api/v2/controller/project/projectsprojectidnotifications
• api/v2/controller/project/projectsprojectidnotificationsws

It is recommended to use the WebSocket endpoint.

Available notifications

ping

Keep-alive between client and controller. Also used to receive the current CPU and memory usage.

api/notifications/ping.json

node.created

A node has been created.

api/notifications/node.created.json

node.updated

A node has been updated.

api/notifications/node.updated.json

node.deleted

A node has been deleted.

api/notifications/node.deleted.json

link.created

A link has been created. Note that a link is not connected to any node when it is created.

api/notifications/link.created.json

link.updated

A link has been updated.

api/notifications/link.updated.json

link.deleted

A link has been deleted.

api/notifications/link.deleted.json

drawing.created

A drawing has been created.

api/notifications/drawing.created.json

drawing.updated

A drawing has been updated. The svg field is only included if it has changed in order to reduce data transfer.

api/notifications/drawing.updated.json

drawing.deleted

A drawing has been deleted.

api/notifications/drawing.deleted.json

snapshot.restored

A snapshot has been restored

api/notifications/snapshot.restored.json

log.error

Sends an error

api/notifications/log.error.json

log.warning

Sends a warning

api/notifications/log.warning.json

log.info

Sends an information

api/notifications/log.info.json