JupyterHub Servers API
Single-user server lifecycle.
JupyterHub Servers API is one of 11 APIs that JupyterHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 3 JSON Schema definitions.
Tagged areas include Servers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.
This API exposes 4 operations across 2 paths. It is described by OpenAPI 3.1.0, at version 5.2.0.
Requests are made against a single base URL, http://localhost:8000/hub/api.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
JupyterHub Servers API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (token).
It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 9 scopes.
By default, every request must be authenticated.
token— Token-based authentication. Use the form: Authorization: token
Paths & Operations 4
Across 2 paths, the API surfaces 4 operations — 2 DELETE, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Single-user server lifecycle.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from JupyterHub 10
Other APIs JupyterHub publishes across the network.