Jupyter Notebook

Jupyter Notebook Proxy API

Configurable HTTP proxy routing table management.

GitHub OpenAPI

Operations 3

GET /proxy Jupyter Notebook Get proxy routing table #
POST /proxy Jupyter Notebook Force proxy sync #
PATCH /proxy Jupyter Notebook Add a proxy route #

Documentation

📖
Documentation
https://jupyter-notebook.readthedocs.io/en/stable/rest_api.html
📖
Documentation
https://jupyter-kernel-gateway.readthedocs.io/en/latest/
📖
Documentation
https://jupyterhub.readthedocs.io/en/stable/reference/rest-api.html

Specifications

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/jupyter-notebook/refs/heads/main/json-schema/jupyter-notebook-document.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/jupyter-notebook/refs/heads/main/json-schema/jupyter-contents-model.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/jupyter-notebook/refs/heads/main/json-schema/jupyter-kernel-spec.json

Other Resources

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

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/jupyter-notebook-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

jupyter-notebook-proxy-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Jupyter Notebook JupyterHub REST Proxy API
  description: REST API for JupyterHub, the multi-user server for Jupyter notebooks. This API provides endpoints for managing users, groups, services, proxy routes, and the hub itself. JupyterHub spawns, manages, and proxies multiple instances of single-user Jupyter notebook servers.
  version: 5.0.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: []
- oAuthToken: []
tags:
- name: Proxy
  description: Configurable HTTP proxy routing table management.
paths:
  /proxy:
    get:
      operationId: getProxyTable
      summary: Jupyter Notebook Get proxy routing table
      description: Get the current proxy routing table from the configurable HTTP proxy.
      tags:
      - Proxy
      responses:
        '200':
          description: Proxy routing table.
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/ProxyRoute'
    post:
      operationId: syncProxy
      summary: Jupyter Notebook Force proxy sync
      description: Force the hub to sync the proxy routing table with its database.
      tags:
      - Proxy
      responses:
        '200':
          description: Proxy synced successfully.
    patch:
      operationId: addProxyRoute
      summary: Jupyter Notebook Add a proxy route
      description: Add a new entry to the proxy routing table.
      tags:
      - Proxy
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyRoute'
      responses:
        '201':
          description: Route added successfully.
components:
  schemas:
    ProxyRoute:
      type: object
      description: A proxy routing table entry.
      properties:
        routespec:
          type: string
          description: The route specification, e.g., '/user/username/'.
        target:
          type: string
          description: Target URL to proxy to.
        data:
          type: object
          description: Additional data for the route.
          additionalProperties: true
        last_activity:
          type: string
          format: date-time
          description: Last activity on this route.
  securitySchemes:
    token:
      type: apiKey
      in: header
      name: Authorization
      description: API token passed in the Authorization header as 'token <api_token>'.
    oAuthToken:
      type: http
      scheme: bearer
      description: OAuth2 bearer token.