gns3-server/docs/controller_notifications.rst

Controller notifications

Controller notifications can be received from the controller, they can be used to get information about computes and appliance.

Notification endpoints

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

• api/v2/controller/notification/notifications
• api/v2/controller/notification/notificationsws

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

compute.created

A compute has been created.

api/notifications/compute.created.json

compute.updated

A compute has been updated.

api/notifications/compute.updated.json

compute.deleted

A compute has been deleted.

api/notifications/compute.deleted.json

project.created

A project has been created.

api/notifications/project.created.json

project.updated

A project has been updated.

api/notifications/project.updated.json

project.closed

A project has been closed.

api/notifications/project.closed.json

project.deleted

A project has been deleted.

api/notifications/project.deleted.json

template.created

A template has been created.

api/notifications/template.created.json

template.updated

A template has been updated.

api/notifications/template.updated.json

template.deleted

A template has been deleted.

api/notifications/template.deleted.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