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

JupyterHub Hub API

Hub-level metadata and shutdown.

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

This API exposes 1 JSON Schema definition.

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

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

Requests are made against a single base URL, https://your-jupyterhub-domain.com/hub/api.

4 operations 4 paths 0 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
5.0
Base URL
https://your-jupyterhub-domain.com/hub/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

JupyterHub Hub API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JupyterHub-Token) (tokenAuth). By default, every request must be authenticated.

Paths & Operations 4

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

Hub 4

Hub-level metadata and shutdown.

GET
/
Get JupyterHub version
getHubInfo → 200
GET
/info
Get detailed Hub info
getHubDetailedInfo → 200
GET
/proxy
Get the proxy's routing table
getProxyRoutes → 200
POST
/shutdown
Shut down the Hub
shutdownHub → 202

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jupyter-hub-hub-api-openapi.yml Raw ↑

Other APIs JupyterHub publishes across the network.

JupyterHub Groups API
JupyterHub Services API
JupyterHub Tokens API
JupyterHub Users API