The JupyterHub API

Release:0.8.0.dev Date:Feb 01, 2017

JupyterHub also provides a REST API for administration of the Hub and users. The documentation on Using JupyterHub’s REST API provides information on:

• Creating an API token
• Adding tokens to the configuration file (optional)
• Making an API request

The same JupyterHub API spec, as found here, is available in an interactive form here (on swagger’s petstore). The OpenAPI Initiative (fka Swagger™) is a project used to describe and document RESTful APIs.

JupyterHub API Reference:

• Authenticators
  • Module: jupyterhub.auth
• Spawners
  • Module: jupyterhub.spawner
    • Spawner
• Users
  • Module: jupyterhub.user
    • User
• Authenticating Services
  • Module: jupyterhub.services.auth