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

User accounts and their servers.

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

This API exposes 9 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.

9 operations 4 paths 0 schemas 3 DELETE2 GET4 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 Users 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 9

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

Users 9

User accounts and their servers.

GET
/users
List users
listUsers 3 params → 200
POST
/users
Create multiple users
createUsers body → 201
GET
/users/{name}
Get a user
getUser 1 param → 200
POST
/users/{name}
Create a single user
createUser 1 param → 201
DELETE
/users/{name}
Delete a user
deleteUser 1 param → 204
POST
/users/{name}/server
Start a user's default server
startUserServer 1 param → 201202
DELETE
/users/{name}/server
Stop a user's default server
stopUserServer 1 param → 204
POST
/users/{name}/servers/{server_name}
Start a named server for a user
startNamedServer 2 params → 201
DELETE
/users/{name}/servers/{server_name}
Stop a named server for a user
stopNamedServer 2 params → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs JupyterHub publishes across the network.

JupyterHub Groups API
JupyterHub Hub API
JupyterHub Services API
JupyterHub Tokens API