gns3-server/docs/notifications.rst

Notifications

You can receive notification from the controller allowing you to update your local data.

Notifications endpoints

You can listen the HTTP stream /notifications or the websocket.

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

We recommend using the websocket.

Available notifications

ping

Keep the connection between client and controller.

api/notifications/ping.json

compute.created

Compute has been created.

api/notifications/compute.created.json

compute.updated

Compute has been updated. You will receive a lot of this event because it's include change of CPU and memory usage on the compute node.

api/notifications/compute.updated.json

compute.deleted

Compute has been deleted.

api/notifications/compute.deleted.json

node.created

Node has been created.

api/notifications/node.created.json

node.updated

Node has been updated.

api/notifications/node.updated.json

node.deleted

Node has been deleted.

api/notifications/node.deleted.json

link.created

Link has been created. Note that a link when created is not yet connected to both part.

api/notifications/link.created.json

link.updated

Link has been updated.

api/notifications/link.updated.json

link.deleted

Link has been deleted.

api/notifications/link.deleted.json

drawing.created

Drawing has been created.

api/notifications/drawing.created.json

drawing.updated

Drawing has been updated. To reduce data transfert if the svg field has not change the field is not included.

api/notifications/drawing.updated.json

drawing.deleted

Drawing has been deleted.

api/notifications/drawing.deleted.json

project.updated

Project has been updated.

api/notifications/project.updated.json

project.closed

Project has been closed.

api/notifications/project.closed.json

log.error

Send an error to the user

api/notifications/log.error.json

log.warning

Send a warning to the user

api/notifications/log.warning.json

log.info

Send an information to the user

api/notifications/log.info.json

settings.updated

GUI settings updated. Will be removed in a later release.

api/notifications/settings.updated.json