JupyterHub

JupyterHub Proxy API

Configurable HTTP proxy management.

GitHub OpenAPI

Operations 3

GET /proxy JupyterHub Get proxy routes #
POST /proxy JupyterHub Sync proxy #
PATCH /proxy JupyterHub Update proxy #

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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/jupyterhub-proxy-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

jupyterhub-proxy-api-openapi.yml Raw ↑ 
openapi: 3.2.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