JupyterHub

JupyterHub is a multi-user server for Jupyter notebooks. It manages authentication, spawns and proxies multiple instances of the single-user Jupyter notebook server, and exposes a REST API for managing users, groups, services, tokens, and the proxy.
1 APIs 0 Features
AuthenticationData ScienceEducationHubMulti-UserNotebooksOAuth2Python
APIs

JupyterHub REST API

REST API for managing users, groups, single-user servers, services, tokens, the proxy, and OAuth2 authorization in a JupyterHub deployment. Authenticated via API tokens or OAuth2.
Collections

JupyterHub REST API

OPEN
Pricing Plans

Jupyterhub Plans Pricing

3 plans
PLANS
Rate Limits

Jupyterhub Rate Limits

5 limits
RATE LIMITS
FinOps

Jupyterhub Finops

FINOPS
Semantic Vocabularies

Jupyterhub Context

9 classes · 0 properties
JSON-LD
Resources

GitHubOrganization
Sources

opencollection: 1.0.0
info:
  name: JupyterHub REST API
  version: 5.2.0
request:
  auth:
    type: apikey
    key: Authorization
    value: '{{Authorization}}'
    placement: header
items:
- info:
    name: General
    type: folder
  items:
  - info:
      name: JupyterHub Get version
      type: http
    http:
      method: GET
      url: http://localhost:8000/hub/api/
    docs: Returns the version of the running JupyterHub instance. Does not require authentication.
  - info:
      name: JupyterHub Get detailed info
      type: http
    http:
      method: GET
      url: http://localhost:8000/hub/api/info
    docs: Returns detailed information about the running Hub, including authenticator and spawner classes.
- info:
    name: Users
    type: folder
  items:
  - info:
      name: JupyterHub List users
      type: http
    http:
      method: GET
      url: http://localhost:8000/hub/api/users
      params:
      - name: state
        value: ''
        type: query
      - name: offset
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
    docs: Returns a list of all Hub users. Requires admin permissions or list:users scope.
  - info:
      name: JupyterHub Create users
      type: http
    http:
      method: POST
      url: http://localhost:8000/hub/api/users
    docs: Creates one or more users.
  - info:
      name: JupyterHub Get user
      type: http
    http:
      method: GET
      url: http://localhost:8000/hub/api/users/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Returns the user object for the named user.
  - info:
      name: JupyterHub Create user
      type: http
    http:
      method: POST
      url: http://localhost:8000/hub/api/users/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Creates the named user.
  - info:
      name: JupyterHub Update user
      type: http
    http:
      method: PATCH
      url: http://localhost:8000/hub/api/users/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Updates the named user, for example to rename or grant admin status.
  - info:
      name: JupyterHub Delete user
      type: http
    http:
      method: DELETE
      url: http://localhost:8000/hub/api/users/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Deletes the named user.
- info:
    name: Activity
    type: folder
  items:
  - info:
      name: JupyterHub Notify user activity
      type: http
    http:
      method: POST
      url: http://localhost:8000/hub/api/users/:name/activity
      params:
      - name: name
        value: ''
        type: path
    docs: Notifies the Hub of activity for the named user. Used by single-user servers to extend their lifetime.
- info:
    name: Servers
    type: folder
  items:
  - info:
      name: JupyterHub Start user server
      type: http
    http:
      method: POST
      url: http://localhost:8000/hub/api/users/:name/server
      params:
      - name: name
        value: ''
        type: path
    docs: Starts the default single-user server for the named user.
  - info:
      name: JupyterHub Stop user server
      type: http
    http:
      method: DELETE
      url: http://localhost:8000/hub/api/users/:name/server
      params:
      - name: name
        value: ''
        type: path
    docs: Stops the default single-user server for the named user.
  - info:
      name: JupyterHub Start named server
      type: http
    http:
      method: POST
      url: http://localhost:8000/hub/api/users/:name/servers/:server_name
      params:
      - name: name
        value: ''
        type: path
      - name: server_name
        value: ''
        type: path
    docs: Starts a named single-user server for the named user.
  - info:
      name: JupyterHub Stop named server
      type: http
    http:
      method: DELETE
      url: http://localhost:8000/hub/api/users/:name/servers/:server_name
      params:
      - name: name
        value: ''
        type: path
      - name: server_name
        value: ''
        type: path
    docs: Stops the named single-user server for the named user.
- info:
    name: Tokens
    type: folder
  items:
  - info:
      name: JupyterHub List user tokens
      type: http
    http:
      method: GET
      url: http://localhost:8000/hub/api/users/:name/tokens
      params:
      - name: name
        value: ''
        type: path
    docs: Returns the list of API tokens for the named user.
  - info:
      name: JupyterHub Create user token
      type: http
    http:
      method: POST
      url: http://localhost:8000/hub/api/users/:name/tokens
      params:
      - name: name
        value: ''
        type: path
    docs: Creates a new API token for the named user.
  - info:
      name: JupyterHub Get user token
      type: http
    http:
      method: GET
      url: http://localhost:8000/hub/api/users/:name/tokens/:token_id
      params:
      - name: name
        value: ''
        type: path
      - name: token_id
        value: ''
        type: path
    docs: Retrieves the named token for the named user.
  - info:
      name: JupyterHub Revoke user token
      type: http
    http:
      method: DELETE
      url: http://localhost:8000/hub/api/users/:name/tokens/:token_id
      params:
      - name: name
        value: ''
        type: path
      - name: token_id
        value: ''
        type: path
    docs: Revokes the named token for the named user.
- info:
    name: Groups
    type: folder
  items:
  - info:
      name: JupyterHub List groups
      type: http
    http:
      method: GET
      url: http://localhost:8000/hub/api/groups
    docs: Returns the list of all groups.
  - info:
      name: JupyterHub Create groups
      type: http
    http:
      method: POST
      url: http://localhost:8000/hub/api/groups
    docs: Creates one or more groups.
  - info:
      name: JupyterHub Get group
      type: http
    http:
      method: GET
      url: http://localhost:8000/hub/api/groups/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Returns the named group.
  - info:
      name: JupyterHub Create group
      type: http
    http:
      method: POST
      url: http://localhost:8000/hub/api/groups/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Creates the named group.
  - info:
      name: JupyterHub Delete group
      type: http
    http:
      method: DELETE
      url: http://localhost:8000/hub/api/groups/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Deletes the named group.
  - info:
      name: JupyterHub Add users to group
      type: http
    http:
      method: POST
      url: http://localhost:8000/hub/api/groups/:name/users
      params:
      - name: name
        value: ''
        type: path
    docs: Adds users to the named group.
  - info:
      name: JupyterHub Remove users from group
      type: http
    http:
      method: DELETE
      url: http://localhost:8000/hub/api/groups/:name/users
      params:
      - name: name
        value: ''
        type: path
    docs: Removes users from the named group.
- info:
    name: Services
    type: folder
  items:
  - info:
      name: JupyterHub List services
      type: http
    http:
      method: GET
      url: http://localhost:8000/hub/api/services
    docs: Returns the list of registered Hub services.
  - info:
      name: JupyterHub Get service
      type: http
    http:
      method: GET
      url: http://localhost:8000/hub/api/services/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Returns the named service.
- info:
    name: Proxy
    type: folder
  items:
  - info:
      name: JupyterHub Get proxy routes
      type: http
    http:
      method: GET
      url: http://localhost:8000/hub/api/proxy
    docs: Returns the current proxy routing table.
  - info:
      name: JupyterHub Sync proxy
      type: http
    http:
      method: POST
      url: http://localhost:8000/hub/api/proxy
    docs: Forces the Hub to sync its proxy routing table.
  - info:
      name: JupyterHub Update proxy
      type: http
    http:
      method: PATCH
      url: http://localhost:8000/hub/api/proxy
    docs: Updates the proxy with new authentication or URL.
- info:
    name: Authorizations
    type: folder
  items:
  - info:
      name: JupyterHub Request token
      type: http
    http:
      method: POST
      url: http://localhost:8000/hub/api/authorizations/token
    docs: Requests a new token, given a username and password.
  - info:
      name: JupyterHub Identify token
      type: http
    http:
      method: GET
      url: http://localhost:8000/hub/api/authorizations/token/:token
      params:
      - name: token
        value: ''
        type: path
    docs: Identifies the user or service that owns the given token.
  - info:
      name: JupyterHub Identify cookie
      type: http
    http:
      method: GET
      url: http://localhost:8000/hub/api/authorizations/cookie/:cookie_name/:cookie_value
      params:
      - name: cookie_name
        value: ''
        type: path
      - name: cookie_value
        value: ''
        type: path
    docs: Identifies the user that owns a given cookie.
- info:
    name: OAuth2
    type: folder
  items:
  - info:
      name: JupyterHub OAuth2 authorize
      type: http
    http:
      method: GET
      url: http://localhost:8000/hub/api/oauth2/authorize
    docs: OAuth2 authorization endpoint. Initiates the OAuth2 authorization code flow.
  - info:
      name: JupyterHub OAuth2 token
      type: http
    http:
      method: POST
      url: http://localhost:8000/hub/api/oauth2/token
    docs: OAuth2 token endpoint. Exchanges an authorization code for an access token.
- info:
    name: Admin
    type: folder
  items:
  - info:
      name: JupyterHub Shutdown
      type: http
    http:
      method: POST
      url: http://localhost:8000/hub/api/shutdown
    docs: Shuts down the Hub.
bundled: true