Skip to content

Engine API

Stephen von Takach edited this page Dec 14, 2016 · 3 revisions

Most API requests are authorised via OAuth2 as implemented by the doorkeeper-gem

Authentication is implemented via omniauth allowing single sign on from a number of sources

Engine assumes it is mounted on the root of a domain at: /control

Core Routes

/control/websocket

This is the route for obtaining a persistent connection to the server - user interfaces can use this to determine if the server is online / connectable. It allows interfaces to request realtime updates for status values that they are interested in, debug drivers and code execution.

The users identity is stored during the initial connection with system access and connection logged. The following commands are available:

Command Description
exec Executes a command in a specific system
bind
unbind
debug
ignore