diff options
Diffstat (limited to 'API.rst')
| -rw-r--r-- | API.rst | 28 |
1 files changed, 28 insertions, 0 deletions
@@ -26,6 +26,34 @@ Start a new remote session and register it in RWA {"id": <pid>, "url": "<url>", "pin": <pin>} +status +^^^^^^ +Return the status of a session + +.. note:: + + This uses the last status version got by the update service in the background. + +**Arguments:** pid/id (integer) + +**Return type:** string (JSON) + + +**Structure of returned JSON:** + +:: + + {"id": <pid>, "status": <status>} + +**Possible status options:** + +- ``running``: The session is running and ready for connecting. +- ``joined``: The session is running and a the remote connected to the session. + +refresh_status +^^^^^^^^^^^^^^ +Same as ``status``, but updates status from Django before returning it here. + stop ^^^^ Stop a remote session |
