JupyterHub API

Release

1.2.0dev

Date

Jun 08, 2020

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

• what you can do with the API

• creating an API token

• adding API tokens to the config files

• making an API request programmatically using the requests library

• learning more about JupyterHub’s API

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:

• Application configuration
  • Module: jupyterhub.app
    • JupyterHub
• Authenticators
  • Module: jupyterhub.auth
    • Authenticator
    • LocalAuthenticator
    • PAMAuthenticator
    • DummyAuthenticator
• Spawners
  • Module: jupyterhub.spawner
    • Spawner
    • LocalProcessSpawner
• Proxies
  • Module: jupyterhub.proxy
    • Proxy
    • ConfigurableHTTPProxy
• Users
  • Module: jupyterhub.user
    • UserDict
    • User
• Services
  • Module: jupyterhub.services.service
    • Service
• Services Authentication
  • Module: jupyterhub.services.auth
    • HubAuth
    • HubOAuth
    • HubAuthenticated
    • HubOAuthenticated
    • HubOAuthCallbackHandler

Changelog Application configuration