JupyterHub

JupyterHub Proxy API

Configurable HTTP proxy management.

GitHub OpenAPI

Documentation

📖
Documentation
https://jupyterhub.readthedocs.io/en/stable/reference/rest-api.html
📖
Authentication
https://jupyterhub.readthedocs.io/en/stable/rbac/index.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/jupyterhub/refs/heads/main/openapi/jupyterhub-proxy-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/jupyterhub/refs/heads/main/json-schema/jupyterhub-user.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/jupyterhub/refs/heads/main/json-schema/jupyterhub-server.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/jupyterhub/refs/heads/main/json-schema/jupyterhub-group.json

Other Resources

🔗
Repository
https://github.com/jupyterhub/jupyterhub
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/jupyterhub/refs/heads/main/json-ld/jupyterhub-context.jsonld

OpenAPI Specification

jupyterhub-proxy-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: JupyterHub REST Activity Proxy API
  description: REST API for JupyterHub, the multi-user server for Jupyter notebooks. Provides endpoints for managing users, groups, services, shared servers, OAuth2 authorization, the proxy, and the hub itself. JupyterHub spawns, manages, and proxies multiple instances of the single-user Jupyter notebook server.
  version: 5.2.0
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  contact:
    name: Jupyter Project
    url: https://jupyterhub.readthedocs.io
    email: jupyter@googlegroups.com
servers:
- url: http://localhost:8000/hub/api
  description: Local JupyterHub server
security:
- token: []
tags:
- name: Proxy
  description: Configurable HTTP proxy management.
paths:
  /proxy:
    get:
      operationId: getProxyRoutes
      summary: JupyterHub Get proxy routes
      description: Returns the current proxy routing table.
      tags:
      - Proxy
      responses:
        '200':
          description: Proxy routing table.
    post:
      operationId: syncProxy
      summary: JupyterHub Sync proxy
      description: Forces the Hub to sync its proxy routing table.
      tags:
      - Proxy
      responses:
        '200':
          description: Proxy synchronized.
    patch:
      operationId: updateProxy
      summary: JupyterHub Update proxy
      description: Updates the proxy with new authentication or URL.
      tags:
      - Proxy
      responses:
        '200':
          description: Proxy updated.
components:
  securitySchemes:
    token:
      type: apiKey
      in: header
      name: Authorization
      description: 'Token-based authentication. Use the form: Authorization: token <token>'
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /hub/api/oauth2/authorize
          tokenUrl: /hub/api/oauth2/token
          scopes:
            self: Access to the current user.
            admin:users: Administer users.
            admin:servers: Administer single-user servers.
            read:users: Read user information.
            list:users: List users.
            read:groups: Read group information.
            admin:groups: Administer groups.
            read:services: Read service information.
            proxy: Manage the proxy.
externalDocs:
  description: JupyterHub REST API documentation
  url: https://jupyterhub.readthedocs.io/en/stable/reference/rest-api.html