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

Group membership.

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

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

6 operations 3 paths 0 schemas 2 DELETE2 GET2 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 Groups 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 6

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

Groups 6

Group membership.

GET
/groups
List groups
listGroups → 200
GET
/groups/{name}
Get a group
getGroup 1 param → 200
POST
/groups/{name}
Create a group
createGroup 1 param → 201
DELETE
/groups/{name}
Delete a group
deleteGroup 1 param → 204
POST
/groups/{name}/users
Add users to a group
addUsersToGroup 1 param → 200
DELETE
/groups/{name}/users
Remove users from a group
removeUsersFromGroup 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs JupyterHub publishes across the network.

JupyterHub Hub API
JupyterHub Services API
JupyterHub Tokens API
JupyterHub Users API