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 Kernels API

Running kernels.

Jupyter Notebooks Kernels 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 Kernels. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 6 operations across 4 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.

6 operations 4 paths 0 schemas 1 DELETE2 GET3 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 Kernels API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Jupyter-Token) (tokenAuth).

Paths & Operations 6

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

Kernels 6

Running kernels.

GET
/kernels
List running kernels
listKernels → 200
POST
/kernels
Start a new kernel
startKernel body → 201
GET
/kernels/{kernel_id}
Get kernel info
getKernel 1 param → 200
DELETE
/kernels/{kernel_id}
Shut down a kernel
shutdownKernel 1 param → 204
POST
/kernels/{kernel_id}/interrupt
Interrupt a kernel
interruptKernel 1 param → 204
POST
/kernels/{kernel_id}/restart
Restart a kernel
restartKernel 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Jupyter Notebooks publishes across the network.

Jupyter Notebooks Contents API
Jupyter Notebooks KernelSpecs API
Jupyter Notebooks Sessions API
Jupyter Notebooks Terminals API