Jupyter Terminals API

The Terminals API from Jupyter — 2 operation(s) for terminals.

OpenAPI Specification

jupyter-terminals-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Jupyter Server REST Config Terminals 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: Terminals
paths:
  /api/terminals:
    get:
      summary: List terminals
      operationId: listTerminals
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      tags:
      - Terminals
    post:
      summary: Create terminal
      operationId: createTerminal
      responses:
        '201':
          description: Created
      tags:
      - Terminals
  /api/terminals/{terminal_id}:
    parameters:
    - name: terminal_id
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Get terminal
      operationId: getTerminal
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      tags:
      - Terminals
    delete:
      summary: Close terminal
      operationId: closeTerminal
      responses:
        '204':
          description: Closed
      tags:
      - Terminals
x-generated-from: https://jupyter-notebook.readthedocs.io/en/stable/rest_api.html
x-generated-by: claude-crawl-2026-05-08