How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Jupyter Notebook Users API

User management including creation, deletion, server management, and token management.

Jupyter Notebook Users 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 User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.

This API exposes 15 operations across 7 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version 3.0.0.

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

15 operations 7 paths 3 schemas 4 DELETE4 GET1 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 Users 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 15

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

Users 15

User management including creation, deletion, server management, and token management.

GET
/users
Jupyter Notebook List users
listUsers 4 params → 200403
POST
/users
Jupyter Notebook Create multiple users
createUsers body → 201403409
GET
/users/{name}
Jupyter Notebook Get user details
getUser 2 params → 200403404
POST
/users/{name}
Jupyter Notebook Create a single user
createUser 1 param body → 201409
PATCH
/users/{name}
Jupyter Notebook Update user properties
updateUser 1 param body → 200400404
DELETE
/users/{name}
Jupyter Notebook Delete a user
deleteUser 1 param → 204404
POST
/users/{name}/activity
Jupyter Notebook Notify user activity
notifyUserActivity 1 param body → 200
POST
/users/{name}/server
Jupyter Notebook Start user's default server
startUserServer 1 param body → 201202400
DELETE
/users/{name}/server
Jupyter Notebook Stop user's default server
stopUserServer 2 params → 202204400
POST
/users/{name}/servers/{server_name}
Jupyter Notebook Start a named server
startNamedServer 2 params body → 201202
DELETE
/users/{name}/servers/{server_name}
Jupyter Notebook Stop a named server
stopNamedServer 3 params → 202204
GET
/users/{name}/tokens
Jupyter Notebook List user's API tokens
listUserTokens 1 param → 200403404
POST
/users/{name}/tokens
Jupyter Notebook Create an API token
createUserToken 1 param body → 201403
GET
/users/{name}/tokens/{token_id}
Jupyter Notebook Get token details
getUserToken 2 params → 200404
DELETE
/users/{name}/tokens/{token_id}
Jupyter Notebook Revoke an API token
deleteUserToken 2 params → 204404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are User (11 properties), Token (10 properties), Server (9 properties). Each schema is shown below with its type and property counts.

User
object
A JupyterHub user.
11 properties 2 required
Token
object
An API token.
10 properties 1 required
Server
object
A user's single-user notebook server.
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jupyter-notebook-users-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 Groups 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
Where this information came from

This is an independent, third-party profile of Jupyter Notebook Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.