Jupyter Notebook

Jupyter Notebook Groups API

Group management for organizing users.

GitHub OpenAPI

Operations 7

GET /groups Jupyter Notebook List groups #
GET /groups/{name} Jupyter Notebook Get group details #
POST /groups/{name} Jupyter Notebook Create a group #
DELETE /groups/{name} Jupyter Notebook Delete a group #
POST /groups/{name}/users Jupyter Notebook Add users to a group #
DELETE /groups/{name}/users Jupyter Notebook Remove users from a group #
PUT /groups/{name}/properties Jupyter Notebook Set group properties #

Documentation

📖
Documentation
https://jupyter-notebook.readthedocs.io/en/stable/rest_api.html
📖
Documentation
https://jupyter-kernel-gateway.readthedocs.io/en/latest/
📖
Documentation
https://jupyterhub.readthedocs.io/en/stable/reference/rest-api.html

Specifications

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/jupyter-notebook/refs/heads/main/json-schema/jupyter-notebook-document.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/jupyter-notebook/refs/heads/main/json-schema/jupyter-contents-model.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/jupyter-notebook/refs/heads/main/json-schema/jupyter-kernel-spec.json

Other Resources

🔗
Repository
https://github.com/jupyter/notebook
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/jupyter-notebook/refs/heads/main/json-ld/jupyter-notebook-context.jsonld
🔗
Repository
https://github.com/jupyter-server/kernel_gateway
🔗
Repository
https://github.com/jupyterhub/jupyterhub

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/jupyter-notebook-groups-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

jupyter-notebook-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Jupyter Notebook Jupyter Kernel Gateway Authorization Groups API
  description: 'REST API for the Jupyter Kernel Gateway, a web server that provides headless access to Jupyter kernels. The Kernel Gateway supports two modes: jupyter-websocket mode (default) which provides a Jupyter Notebook server-compatible API for kernel management, and notebook-http mode which maps notebook cells to HTTP endpoints. This spec covers the jupyter-websocket mode API.'
  version: 3.0.0
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  contact:
    name: Jupyter Project
    url: https://jupyter-kernel-gateway.readthedocs.io
    email: jupyter@googlegroups.com
servers:
- url: http://localhost:8888/api
  description: Local Jupyter Kernel Gateway server
security:
- token: []
- tokenQuery: []
tags:
- name: Groups
  description: Group management for organizing users.
paths:
  /groups:
    get:
      operationId: listGroups
      summary: Jupyter Notebook List groups
      description: List all groups.
      tags:
      - Groups
      parameters:
      - name: offset
        in: query
        required: false
        description: Offset for pagination.
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        required: false
        description: Maximum number of groups to return.
        schema:
          type: integer
          default: 100
      responses:
        '200':
          description: List of groups.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Group'
        '403':
          description: Forbidden.
  /groups/{name}:
    get:
      operationId: getGroup
      summary: Jupyter Notebook Get group details
      description: Get information about a specific group.
      tags:
      - Groups
      parameters:
      - name: name
        in: path
        required: true
        description: Group name.
        schema:
          type: string
      responses:
        '200':
          description: Group details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
        '404':
          description: Group not found.
    post:
      operationId: createGroup
      summary: Jupyter Notebook Create a group
      description: Create a new group with the given name.
      tags:
      - Groups
      parameters:
      - name: name
        in: path
        required: true
        description: Group name.
        schema:
          type: string
      responses:
        '201':
          description: Group created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
        '409':
          description: Group already exists.
    delete:
      operationId: deleteGroup
      summary: Jupyter Notebook Delete a group
      description: Delete a group. Users in the group are not deleted.
      tags:
      - Groups
      parameters:
      - name: name
        in: path
        required: true
        description: Group name.
        schema:
          type: string
      responses:
        '204':
          description: Group deleted successfully.
        '404':
          description: Group not found.
  /groups/{name}/users:
    post:
      operationId: addGroupUsers
      summary: Jupyter Notebook Add users to a group
      description: Add one or more users to a group.
      tags:
      - Groups
      parameters:
      - name: name
        in: path
        required: true
        description: Group name.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                users:
                  type: array
                  description: List of usernames to add.
                  items:
                    type: string
              required:
              - users
      responses:
        '200':
          description: Users added to group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
        '404':
          description: Group not found.
    delete:
      operationId: removeGroupUsers
      summary: Jupyter Notebook Remove users from a group
      description: Remove one or more users from a group.
      tags:
      - Groups
      parameters:
      - name: name
        in: path
        required: true
        description: Group name.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                users:
                  type: array
                  description: List of usernames to remove.
                  items:
                    type: string
              required:
              - users
      responses:
        '200':
          description: Users removed from group.
        '404':
          description: Group not found.
  /groups/{name}/properties:
    put:
      operationId: setGroupProperties
      summary: Jupyter Notebook Set group properties
      description: Set or replace all custom properties for a group.
      tags:
      - Groups
      parameters:
      - name: name
        in: path
        required: true
        description: Group name.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Properties set successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
components:
  schemas:
    Group:
      type: object
      description: A JupyterHub user group.
      properties:
        name:
          type: string
          description: The group name.
        users:
          type: array
          description: List of usernames in the group.
          items:
            type: string
        roles:
          type: array
          description: Roles assigned to the group.
          items:
            type: string
        properties:
          type: object
          description: Custom properties for the group.
          additionalProperties: true
      required:
      - name
      - users
  securitySchemes:
    token:
      type: apiKey
      in: header
      name: Authorization
      description: Authentication token configured via KG_AUTH_TOKEN. Passed as 'token <token_value>' in the Authorization header.
    tokenQuery:
      type: apiKey
      in: query
      name: token
      description: Authentication token passed as a query parameter.