OpenAPI Specification
openapi: 3.0.3
info:
title: Jupyter Notebook Server REST Contents Sessions 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: Sessions
description: Notebook sessions.
paths:
/sessions:
get:
tags:
- Sessions
summary: List active sessions
operationId: listSessions
responses:
'200':
description: List of active sessions.
post:
tags:
- Sessions
summary: Create a new session
operationId: createSession
responses:
'201':
description: Session created.
/sessions/{session_id}:
parameters:
- in: path
name: session_id
required: true
schema:
type: string
get:
tags:
- Sessions
summary: Get a session
operationId: getSession
responses:
'200':
description: Session details.
patch:
tags:
- Sessions
summary: Update a session
operationId: updateSession
responses:
'200':
description: Session updated.
delete:
tags:
- Sessions
summary: Delete a session
operationId: deleteSession
responses:
'204':
description: Session deleted.
components:
securitySchemes:
tokenAuth:
type: http
scheme: bearer
bearerFormat: Jupyter-Token