Jupyter Kernels API

The Kernels API from Jupyter — 4 operation(s) for kernels.

OpenAPI Specification

jupyter-kernels-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Jupyter Server REST Config Kernels API
  description: Minimal OpenAPI 3.1 description of the Jupyter Server REST API for managing notebook contents, sessions, kernels, terminals, checkpoints, and configuration.
  version: 1.0.0
servers:
- url: http://localhost:8888
  description: Local Jupyter Server
tags:
- name: Kernels
paths:
  /api/kernels:
    get:
      summary: List kernels
      operationId: listKernels
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      tags:
      - Kernels
    post:
      summary: Start kernel
      operationId: startKernel
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Created
      tags:
      - Kernels
  /api/kernels/{kernel_id}:
    parameters:
    - name: kernel_id
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Get kernel
      operationId: getKernel
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      tags:
      - Kernels
    delete:
      summary: Stop kernel
      operationId: stopKernel
      responses:
        '204':
          description: Stopped
      tags:
      - Kernels
  /api/kernels/{kernel_id}/interrupt:
    parameters:
    - name: kernel_id
      in: path
      required: true
      schema:
        type: string
    post:
      summary: Interrupt kernel
      operationId: interruptKernel
      responses:
        '204':
          description: Interrupted
      tags:
      - Kernels
  /api/kernels/{kernel_id}/restart:
    parameters:
    - name: kernel_id
      in: path
      required: true
      schema:
        type: string
    post:
      summary: Restart kernel
      operationId: restartKernel
      responses:
        '200':
          description: OK
      tags:
      - Kernels
x-generated-from: https://jupyter-notebook.readthedocs.io/en/stable/rest_api.html
x-generated-by: claude-crawl-2026-05-08