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

Configurable HTTP proxy management.

JupyterHub Proxy 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 Proxy. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.

This API exposes 3 operations across 1 path. 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.

3 operations 1 paths 0 schemas 1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
5.2.0
Base URL
http://localhost:8000/hub/api
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

JupyterHub Proxy 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 3

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

Proxy 3

Configurable HTTP proxy management.

GET
/proxy
JupyterHub Get proxy routes
getProxyRoutes → 200
POST
/proxy
JupyterHub Sync proxy
syncProxy → 200
PATCH
/proxy
JupyterHub Update proxy
updateProxy → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jupyterhub-proxy-api-openapi.yml Raw ↑

Other APIs JupyterHub publishes across the network.

JupyterHub Activity API
JupyterHub Admin API
JupyterHub Authorizations API
JupyterHub General API
JupyterHub Groups API
JupyterHub OAuth2 API
JupyterHub Servers API
JupyterHub Services API
JupyterHub Tokens API
JupyterHub Users API