Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Jupyter Notebooks Terminals API

Terminal sessions.

Jupyter Notebooks Terminals API is one of 5 APIs that Jupyter Notebooks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Terminals. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 4 operations across 2 paths. It is described by OpenAPI 3.0.3, at version 7.0.

Requests are made against a single base URL, http://localhost:8888/api.

4 operations 2 paths 0 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
7.0
Base URL
http://localhost:8888/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Jupyter Notebooks Terminals API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Jupyter-Token) (tokenAuth).

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Terminals 4

Terminal sessions.

GET
/terminals
List active terminals
listTerminals → 200
POST
/terminals
Start a new terminal
startTerminal → 201
GET
/terminals/{terminal_id}
Get a terminal
getTerminal 1 param → 200
DELETE
/terminals/{terminal_id}
Stop a terminal
stopTerminal 1 param → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jupyter-notebooks-terminals-api-openapi.yml Raw ↑

Other APIs Jupyter Notebooks publishes across the network.

Jupyter Notebooks Contents API
Jupyter Notebooks Kernels API
Jupyter Notebooks KernelSpecs API
Jupyter Notebooks Sessions API