Jupyter Server Terminals API

openapi: 3.1.0
info:
  title: Jupyter Server REST Checkpoints Terminals 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: Terminals
  description: Terminal session management.
paths:
  /terminals:
    get:
      operationId: listTerminals
      summary: Jupyter Server List terminals
      description: Returns the list of running terminal sessions.
      tags:
      - Terminals
      responses:
        '200':
          description: List of terminal objects.
    post:
      operationId: createTerminal
      summary: Jupyter Server Create terminal
      description: Starts a new terminal session.
      tags:
      - Terminals
      responses:
        '200':
          description: Newly created terminal object.
  /terminals/{terminal_id}:
    get:
      operationId: getTerminal
      summary: Jupyter Server Get terminal
      description: Retrieves the terminal session by name.
      tags:
      - Terminals
      parameters:
      - name: terminal_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Terminal object.
    delete:
      operationId: deleteTerminal
      summary: Jupyter Server Delete terminal
      description: Deletes the terminal session.
      tags:
      - Terminals
      parameters:
      - name: terminal_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Terminal deleted.
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