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

Server configuration sections.

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

This API exposes 2 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.

2 operations 1 paths 0 schemas 1 GET1 PATCH

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 Config 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 2

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

Config 2

Server configuration sections.

GET
/config/{section_name}
Jupyter Server Get config section
getConfig 1 param → 200
PATCH
/config/{section_name}
Jupyter Server Update config section
updateConfig 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Jupyter Server publishes across the network.

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