Jupyter Contents API

openapi: 3.1.0
info:
  title: Jupyter Server REST Config Contents 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: Contents
paths:
  /api/contents/{path}:
    parameters:
    - name: path
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Get file or directory contents
      operationId: getContents
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      tags:
      - Contents
    post:
      summary: Create new file or directory
      operationId: createContents
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Created
      tags:
      - Contents
    put:
      summary: Save or upload file
      operationId: saveContents
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: OK
      tags:
      - Contents
    patch:
      summary: Rename file or directory
      operationId: renameContents
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: OK
      tags:
      - Contents
    delete:
      summary: Delete file or directory
      operationId: deleteContents
      responses:
        '204':
          description: Deleted
      tags:
      - Contents
  /api/contents/{path}/checkpoints:
    parameters:
    - name: path
      in: path
      required: true
      schema:
        type: string
    get:
      summary: List checkpoints for a file
      operationId: listCheckpoints
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      tags:
      - Contents
    post:
      summary: Create checkpoint
      operationId: createCheckpoint
      responses:
        '201':
          description: Created
      tags:
      - Contents
  /api/contents/{path}/checkpoints/{checkpoint_id}:
    parameters:
    - name: path
      in: path
      required: true
      schema:
        type: string
    - name: checkpoint_id
      in: path
      required: true
      schema:
        type: string
    post:
      summary: Restore checkpoint
      operationId: restoreCheckpoint
      responses:
        '204':
          description: Restored
      tags:
      - Contents
    delete:
      summary: Delete checkpoint
      operationId: deleteCheckpoint
      responses:
        '204':
          description: Deleted
      tags:
      - Contents
x-generated-from: https://jupyter-notebook.readthedocs.io/en/stable/rest_api.html
x-generated-by: claude-crawl-2026-05-08