OpenAPI Specification
openapi: 3.0.3
info:
title: Jupyter Notebook Server REST Contents Terminals API
description: REST API for the Jupyter Notebook server, providing access to notebook contents, kernels, kernel specs, sessions, and terminals. Used by clients to drive interactive computing workflows.
version: '7.0'
contact:
name: Project Jupyter
url: https://jupyter.org
license:
name: BSD-3-Clause
url: https://github.com/jupyter/notebook/blob/main/LICENSE
servers:
- url: http://localhost:8888/api
description: Local Jupyter Notebook server
tags:
- name: Terminals
description: Terminal sessions.
paths:
/terminals:
get:
tags:
- Terminals
summary: List active terminals
operationId: listTerminals
responses:
'200':
description: List of active terminals.
post:
tags:
- Terminals
summary: Start a new terminal
operationId: startTerminal
responses:
'201':
description: Terminal started.
/terminals/{terminal_id}:
parameters:
- in: path
name: terminal_id
required: true
schema:
type: string
get:
tags:
- Terminals
summary: Get a terminal
operationId: getTerminal
responses:
'200':
description: Terminal details.
delete:
tags:
- Terminals
summary: Stop a terminal
operationId: stopTerminal
responses:
'204':
description: Terminal stopped.
components:
securitySchemes:
tokenAuth:
type: http
scheme: bearer
bearerFormat: Jupyter-Token