How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Jupyter Notebook General API

General gateway information.

Jupyter Notebook General API is one of 14 APIs that Jupyter Notebook publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version 3.0.0.

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

4 operations 4 paths 2 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0.0
Base URL
http://localhost:8888/api
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Jupyter Notebook General 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 query as token (tokenQuery). By default, every request must be authenticated.

  • token — Authentication token configured via KGAUTHTOKEN. Passed as 'token ' in the Authorization header.
  • tokenQuery — Authentication token passed as a query parameter.

Paths & Operations 4

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

General 4

General gateway information.

GET
/api
Jupyter Notebook Get API info
getApiInfo → 200
GET
/api/status
Jupyter Notebook Get server status
getApiStatus → 200
GET
/
Jupyter Notebook Get JupyterHub version
getRootInfo → 200
GET
/info
Jupyter Notebook Get detailed server info
getInfo → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are HubInfo (5 properties), ServerStatus (4 properties). Each schema is shown below with its type and property counts.

HubInfo
object
Detailed JupyterHub server information.
5 properties
ServerStatus
object
Notebook server status information.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jupyter-notebook-general-api-openapi.yml Raw ↑

Other APIs Jupyter Notebook publishes across the network.

Jupyter Kernel Messaging Protocol
Jupyter Notebook Authorization API
Jupyter Notebook Config API
Jupyter Notebook Contents API
Jupyter Notebook Groups API
Jupyter Notebook Hub API
Jupyter Notebook Kernels API
Jupyter Notebook Kernelspecs API
Jupyter Notebook Proxy API
Jupyter Notebook Services API
Jupyter Notebook Sessions API
Jupyter Notebook Terminals API
Where this information came from

This is an independent, third-party profile of Jupyter Notebook General API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.