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

The Contents API from Jupyter — 3 operation(s) for contents.

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

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

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

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

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.1.0
API Version
1.0.0
Base URL
http://localhost:8888
Resource Areas
1

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
GET
/api/contents/{path}
Get file or directory contents
getContents 1 param → 200
POST
/api/contents/{path}
Create new file or directory
createContents 1 param body → 201
PUT
/api/contents/{path}
Save or upload file
saveContents 1 param body → 200
PATCH
/api/contents/{path}
Rename file or directory
renameContents 1 param body → 200
DELETE
/api/contents/{path}
Delete file or directory
deleteContents 1 param → 204
GET
/api/contents/{path}/checkpoints
List checkpoints for a file
listCheckpoints 1 param → 200
POST
/api/contents/{path}/checkpoints
Create checkpoint
createCheckpoint 1 param → 201
POST
/api/contents/{path}/checkpoints/{checkpoint_id}
Restore checkpoint
restoreCheckpoint 2 params → 204
DELETE
/api/contents/{path}/checkpoints/{checkpoint_id}
Delete checkpoint
deleteCheckpoint 2 params → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jupyter-contents-api-openapi.yml Raw ↑

Other APIs Jupyter publishes across the network.

Jupyter Server
JupyterHub
JupyterLab
Jupyter Config API
Jupyter Jupyter Server REST API API
Jupyter Kernels API
Jupyter Kernelspecs API
Jupyter Me API
Jupyter Sessions API
Jupyter Status API
Jupyter Terminals API