openapi: 3.1.0
info:
  title: Jupyter Server REST Checkpoints Kernels API
  description: Core REST API for Jupyter Server, the backend that powers Jupyter Notebook, JupyterLab, and other Jupyter web applications. Provides endpoints for managing kernels, sessions, contents (notebooks and files), terminals, kernel specifications, configuration, and server status.
  version: 2.14.0
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  contact:
    name: Jupyter Project
    url: https://jupyter-server.readthedocs.io
    email: jupyter@googlegroups.com
servers:
- url: http://localhost:8888/api
  description: Local Jupyter Server
security:
- token: []
tags:
- name: Kernels
  description: Kernel lifecycle management.
paths:
  /kernels:
    get:
      operationId: listKernels
      summary: Jupyter Server List kernels
      description: Returns the list of running kernels.
      tags:
      - Kernels
      responses:
        '200':
          description: List of kernel objects.
    post:
      operationId: startKernel
      summary: Jupyter Server Start kernel
      description: Starts a new kernel.
      tags:
      - Kernels
      responses:
        '201':
          description: Newly started kernel object.
  /kernels/{kernel_id}:
    get:
      operationId: getKernel
      summary: Jupyter Server Get kernel
      description: Retrieves the kernel model by ID.
      tags:
      - Kernels
      parameters:
      - name: kernel_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Kernel object.
    delete:
      operationId: shutdownKernel
      summary: Jupyter Server Shutdown kernel
      description: Shuts down the kernel.
      tags:
      - Kernels
      parameters:
      - name: kernel_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Kernel shut down.
  /kernels/{kernel_id}/interrupt:
    post:
      operationId: interruptKernel
      summary: Jupyter Server Interrupt kernel
      description: Sends an interrupt signal to the kernel.
      tags:
      - Kernels
      parameters:
      - name: kernel_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Kernel interrupted.
  /kernels/{kernel_id}/restart:
    post:
      operationId: restartKernel
      summary: Jupyter Server Restart kernel
      description: Restarts the kernel.
      tags:
      - Kernels
      parameters:
      - name: kernel_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Restarted kernel object.
components:
  securitySchemes:
    token:
      type: apiKey
      in: header
      name: Authorization
      description: 'Token-based authentication. Use the form: Authorization: token <token>'
    xsrf:
      type: apiKey
      in: header
      name: X-XSRFToken
      description: XSRF token required for browser-based requests.
externalDocs:
  description: Jupyter Server REST API documentation
  url: https://jupyter-server.readthedocs.io/en/latest/developers/rest-api.html