Jupyter Server

Jupyter Server Terminals API

Terminal session management.

GitHub OpenAPI

Operations 4

GET /terminals Jupyter Server List terminals #
POST /terminals Jupyter Server Create terminal #
GET /terminals/{terminal_id} Jupyter Server Get terminal #
DELETE /terminals/{terminal_id} Jupyter Server Delete terminal #

Documentation

📖
Documentation
https://jupyter-server.readthedocs.io/en/latest/developers/rest-api.html

Specifications

⚙
OpenAPI
https://artifacts.apis.io/jupyter-server/openapi/jupyter-server-terminals-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/jupyter-server/json-schema/jupyter-server-contents-model.json
📊
JSONSchema
https://artifacts.apis.io/jupyter-server/json-schema/jupyter-server-kernel.json
📊
JSONSchema
https://artifacts.apis.io/jupyter-server/json-schema/jupyter-server-session.json

Other Resources

🔗
Repository
https://github.com/jupyter-server/jupyter_server
🔗
ChangeLog
https://github.com/jupyter-server/jupyter_server/blob/main/CHANGELOG.md
🔗
JSONLDContext
https://artifacts.apis.io/jupyter-server/json-ld/jupyter-server-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/jupyter-server:jupyter-server-terminals-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

jupyter-server-terminals-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Jupyter Server REST 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