mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-18 07:23:00 +00:00
2c47fd4a02
/api/ is not authenticated, and just reports JupyterHub's version for now. /api/info is admin-only, and reports more detailed info about Python, authenticators/spawners in use, etc.
108 lines
3.1 KiB
Python
108 lines
3.1 KiB
Python
"""API handlers for administering the Hub itself"""
|
|
|
|
# Copyright (c) Jupyter Development Team.
|
|
# Distributed under the terms of the Modified BSD License.
|
|
|
|
import json
|
|
import sys
|
|
|
|
from tornado import web
|
|
from tornado.ioloop import IOLoop
|
|
|
|
from ..utils import admin_only
|
|
from .base import APIHandler
|
|
from ..version import __version__
|
|
|
|
|
|
class ShutdownAPIHandler(APIHandler):
|
|
|
|
@admin_only
|
|
def post(self):
|
|
"""POST /api/shutdown triggers a clean shutdown
|
|
|
|
POST (JSON) parameters:
|
|
|
|
- servers: specify whether single-user servers should be terminated
|
|
- proxy: specify whether the proxy should be terminated
|
|
"""
|
|
from ..app import JupyterHub
|
|
app = JupyterHub.instance()
|
|
|
|
data = self.get_json_body()
|
|
if data:
|
|
if 'proxy' in data:
|
|
proxy = data['proxy']
|
|
if proxy not in {True, False}:
|
|
raise web.HTTPError(400, "proxy must be true or false, got %r" % proxy)
|
|
app.cleanup_proxy = proxy
|
|
if 'servers' in data:
|
|
servers = data['servers']
|
|
if servers not in {True, False}:
|
|
raise web.HTTPError(400, "servers must be true or false, got %r" % servers)
|
|
app.cleanup_servers = servers
|
|
|
|
# finish the request
|
|
self.set_status(202)
|
|
self.finish(json.dumps({
|
|
"message": "Shutting down Hub"
|
|
}))
|
|
|
|
# stop the eventloop, which will trigger cleanup
|
|
loop = IOLoop.current()
|
|
loop.add_callback(loop.stop)
|
|
|
|
|
|
class RootAPIHandler(APIHandler):
|
|
|
|
def get(self):
|
|
"""GET /api/ returns info about the Hub and its API.
|
|
|
|
It is not an authenticated endpoint.
|
|
|
|
For now, it just returns the version of JupyterHub itself.
|
|
"""
|
|
data = {
|
|
'version': __version__,
|
|
}
|
|
self.finish(json.dumps(data))
|
|
|
|
|
|
class InfoAPIHandler(APIHandler):
|
|
|
|
@admin_only
|
|
def get(self):
|
|
"""GET /api/info returns detailed info about the Hub and its API.
|
|
|
|
It is not an authenticated endpoint.
|
|
|
|
For now, it just returns the version of JupyterHub itself.
|
|
"""
|
|
def _class_info(typ):
|
|
"""info about a class (Spawner or Authenticator)"""
|
|
info = {
|
|
'class': '{mod}.{name}'.format(mod=typ.__module__, name=typ.__name__),
|
|
}
|
|
pkg = typ.__module__.split('.')[0]
|
|
try:
|
|
version = sys.modules[pkg].__version__
|
|
except (KeyError, AttributeError):
|
|
version = 'unknown'
|
|
info['version'] = version
|
|
return info
|
|
|
|
data = {
|
|
'version': __version__,
|
|
'python': sys.version,
|
|
'sys_executable': sys.executable,
|
|
'spawner': _class_info(self.settings['spawner_class']),
|
|
'authenticator': _class_info(self.authenticator.__class__),
|
|
}
|
|
self.finish(json.dumps(data))
|
|
|
|
|
|
default_handlers = [
|
|
(r"/api/shutdown", ShutdownAPIHandler),
|
|
(r"/api/?", RootAPIHandler),
|
|
(r"/api/info", InfoAPIHandler),
|
|
]
|