Jupyter Notebook

Jupyter Notebook Config API

Server configuration section management.

GitHub OpenAPI

Operations 3

GET /api/config/{section_name} Jupyter Notebook Get configuration section #
PUT /api/config/{section_name} Jupyter Notebook Update configuration section #
PATCH /api/config/{section_name} Jupyter Notebook Patch configuration section #

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-config-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-config-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-config-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Jupyter Notebook Jupyter Kernel Gateway Authorization Config API
  description: 'REST API for the Jupyter Kernel Gateway, a web server that provides headless access to Jupyter kernels. The Kernel Gateway supports two modes: jupyter-websocket mode (default) which provides a Jupyter Notebook server-compatible API for kernel management, and notebook-http mode which maps notebook cells to HTTP endpoints. This spec covers the jupyter-websocket mode API.'
  version: 3.0.0
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  contact:
    name: Jupyter Project
    url: https://jupyter-kernel-gateway.readthedocs.io
    email: jupyter@googlegroups.com
servers:
- url: http://localhost:8888/api
  description: Local Jupyter Kernel Gateway server
security:
- token: []
- tokenQuery: []
tags:
- name: Config
  description: Server configuration section management.
paths:
  /api/config/{section_name}:
    get:
      operationId: getConfig
      summary: Jupyter Notebook Get configuration section
      description: Get the configuration values for a specific section.
      tags:
      - Config
      parameters:
      - name: section_name
        in: path
        required: true
        description: Name of the configuration section.
        schema:
          type: string
      responses:
        '200':
          description: Configuration section values.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
    put:
      operationId: updateConfig
      summary: Jupyter Notebook Update configuration section
      description: Update the configuration values for a specific section. The provided values are merged with existing configuration.
      tags:
      - Config
      parameters:
      - name: section_name
        in: path
        required: true
        description: Name of the configuration section.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Configuration updated successfully.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
    patch:
      operationId: patchConfig
      summary: Jupyter Notebook Patch configuration section
      description: Partially update configuration values for a specific section. Only the provided keys are updated.
      tags:
      - Config
      parameters:
      - name: section_name
        in: path
        required: true
        description: Name of the configuration section.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Configuration patched successfully.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
components:
  securitySchemes:
    token:
      type: apiKey
      in: header
      name: Authorization
      description: Authentication token configured via KG_AUTH_TOKEN. Passed as 'token <token_value>' in the Authorization header.
    tokenQuery:
      type: apiKey
      in: query
      name: token
      description: Authentication token passed as a query parameter.