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

Jupyter Notebook Groups API

Group management for organizing users.

Jupyter Notebook Groups API is one of 14 APIs that Jupyter Notebook publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.

This API exposes 7 operations across 4 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against a single base URL, http://localhost:8888/api.

7 operations 4 paths 1 schemas 2 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Base URL
http://localhost:8888/api
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Jupyter Notebook Groups API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (token). An API key is passed in the query as token (tokenQuery). By default, every request must be authenticated.

  • token — Authentication token configured via KGAUTHTOKEN. Passed as 'token ' in the Authorization header.
  • tokenQuery — Authentication token passed as a query parameter.

Paths & Operations 7

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

Groups 7

Group management for organizing users.

GET
/groups
Jupyter Notebook List groups
listGroups 2 params → 200403
GET
/groups/{name}
Jupyter Notebook Get group details
getGroup 1 param → 200404
POST
/groups/{name}
Jupyter Notebook Create a group
createGroup 1 param → 201409
DELETE
/groups/{name}
Jupyter Notebook Delete a group
deleteGroup 1 param → 204404
POST
/groups/{name}/users
Jupyter Notebook Add users to a group
addGroupUsers 1 param body → 200404
DELETE
/groups/{name}/users
Jupyter Notebook Remove users from a group
removeGroupUsers 1 param body → 200404
PUT
/groups/{name}/properties
Jupyter Notebook Set group properties
setGroupProperties 1 param body → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Group (4 properties). Each schema is shown below with its type and property counts.

Group
object
A JupyterHub user group.
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jupyter-notebook-groups-api-openapi.yml Raw ↑

Other APIs Jupyter Notebook publishes across the network.

Jupyter Kernel Messaging Protocol
Jupyter Notebook Authorization API
Jupyter Notebook Config API
Jupyter Notebook Contents API
Jupyter Notebook General API
Jupyter Notebook Hub API
Jupyter Notebook Kernels API
Jupyter Notebook Kernelspecs API
Jupyter Notebook Proxy API
Jupyter Notebook Services API
Jupyter Notebook Sessions API
Jupyter Notebook Terminals API