JupyterHub

JupyterHub Services API

Hub-managed and external services.

GitHub OpenAPI

Documentation

📖
Documentation
https://jupyterhub.readthedocs.io/en/stable/reference/rest-api.html
📖
Authentication
https://jupyterhub.readthedocs.io/en/stable/reference/rest-api.html#authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/jupyter-hub/refs/heads/main/openapi/jupyter-hub-services-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/jupyter-hub/refs/heads/main/json-schema/jupyter-hub-user.json

OpenAPI Specification

jupyter-hub-services-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: JupyterHub REST Groups Services API
  description: REST API for managing JupyterHub users, groups, services, and single-user notebook servers. Authentication is performed via API tokens.
  version: '5.0'
  contact:
    name: Project Jupyter
    url: https://jupyter.org
  license:
    name: BSD-3-Clause
    url: https://github.com/jupyterhub/jupyterhub/blob/main/COPYING.md
servers:
- url: https://your-jupyterhub-domain.com/hub/api
  description: JupyterHub deployment
security:
- tokenAuth: []
tags:
- name: Services
  description: Hub-managed and external services.
paths:
  /services:
    get:
      tags:
      - Services
      summary: List services
      operationId: listServices
      responses:
        '200':
          description: List of registered services.
  /services/{name}:
    parameters:
    - in: path
      name: name
      required: true
      schema:
        type: string
    get:
      tags:
      - Services
      summary: Get a service
      operationId: getService
      responses:
        '200':
          description: Service details.
components:
  securitySchemes:
    tokenAuth:
      type: http
      scheme: bearer
      bearerFormat: JupyterHub-Token