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

Kernel lifecycle management.

Jupyter Server Kernels API is one of 8 APIs that Jupyter Server publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Kernels. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a changelog, and 3 JSON Schemas.

This API exposes 6 operations across 4 paths. It is described by OpenAPI 3.1.0, at version 2.14.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.1.0
API Version
2.14.0
Base URL
http://localhost:8888/api
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Jupyter Server Kernels API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (token). An API key is passed in the header as X-XSRFToken (xsrf). By default, every request must be authenticated.

  • token — Token-based authentication. Use the form: Authorization: token
  • xsrf — XSRF token required for browser-based requests.

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

Kernel lifecycle management.

GET
/kernels
Jupyter Server List kernels
listKernels → 200
POST
/kernels
Jupyter Server Start kernel
startKernel → 201
GET
/kernels/{kernel_id}
Jupyter Server Get kernel
getKernel 1 param → 200
DELETE
/kernels/{kernel_id}
Jupyter Server Shutdown kernel
shutdownKernel 1 param → 204
POST
/kernels/{kernel_id}/interrupt
Jupyter Server Interrupt kernel
interruptKernel 1 param → 204
POST
/kernels/{kernel_id}/restart
Jupyter Server Restart kernel
restartKernel 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Jupyter Server publishes across the network.

Jupyter Server Checkpoints API
Jupyter Server Config API
Jupyter Server Contents API
Jupyter Server General API
Jupyter Server Kernelspecs API
Jupyter Server Sessions API
Jupyter Server Terminals API