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 Notebooks Contents API

Notebook and file contents.

Jupyter Notebooks Contents API is one of 5 APIs that Jupyter Notebooks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Contents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 9 operations across 3 paths. It is described by OpenAPI 3.0.3, at version 7.0.

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

9 operations 3 paths 0 schemas 2 DELETE2 GET1 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
7.0
Base URL
http://localhost:8888/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Jupyter Notebooks Contents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Jupyter-Token) (tokenAuth).

Paths & Operations 9

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

Contents 9

Notebook and file contents.

GET
/contents/{path}
Get contents at a path
getContents 4 params → 200
PUT
/contents/{path}
Save or upload contents at a path
saveContents 1 param → 200201
PATCH
/contents/{path}
Rename or move contents
renameContents 1 param → 200
POST
/contents/{path}
Create a new file or directory
createContents 1 param → 201
DELETE
/contents/{path}
Delete contents at a path
deleteContents 1 param → 204
GET
/contents/{path}/checkpoints
List checkpoints for a file
listCheckpoints 1 param → 200
POST
/contents/{path}/checkpoints
Create a new checkpoint
createCheckpoint 1 param → 201
POST
/contents/{path}/checkpoints/{checkpoint_id}
Restore a file to a checkpoint
restoreCheckpoint 2 params → 204
DELETE
/contents/{path}/checkpoints/{checkpoint_id}
Delete a checkpoint
deleteCheckpoint 2 params → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jupyter-notebooks-contents-api-openapi.yml Raw ↑

Other APIs Jupyter Notebooks publishes across the network.

Jupyter Notebooks Kernels API
Jupyter Notebooks KernelSpecs API
Jupyter Notebooks Sessions API
Jupyter Notebooks Terminals API