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

Notebook and file management operations.

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

This API exposes 3 JSON Schema definitions.

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

This API exposes 5 operations across 1 path. It is described by OpenAPI 3.1.0, at version 2.14.0.

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

5 operations 1 paths 0 schemas 1 DELETE1 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Jupyter Server Contents 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 header as X-XSRFToken (xsrf). By default, every request must be authenticated.

  • token — Token-based authentication. Use the form: Authorization: token
  • xsrf — XSRF token required for browser-based requests.

Paths & Operations 5

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

Contents 5

Notebook and file management operations.

GET
/contents/{path}
Jupyter Server Get contents
getContents 4 params → 200
POST
/contents/{path}
Jupyter Server Create contents
createContents 1 param → 201
PATCH
/contents/{path}
Jupyter Server Rename contents
renameContents 1 param → 200
PUT
/contents/{path}
Jupyter Server Save contents
saveContents 1 param → 200201
DELETE
/contents/{path}
Jupyter Server Delete contents
deleteContents 1 param → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Jupyter Server publishes across the network.

Jupyter Server Checkpoints API
Jupyter Server Config API
Jupyter Server General API
Jupyter Server Kernels API
Jupyter Server Kernelspecs API
Jupyter Server Sessions API
Jupyter Server Terminals API