JupyterLab Settings API
User-defined settings for JupyterLab plugins.
JupyterLab Settings API is one of 7 APIs that JupyterLab publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 2 JSON Schema definitions.
Tagged areas include Settings. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.
This API exposes 3 operations across 2 paths. It is described by OpenAPI 3.1.0, at version 2.27.0.
Requests are made against a single base URL, http://localhost:8888/lab/api.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
JupyterLab Settings 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: tokenxsrf— XSRF token required for browser-based requests.
Paths & Operations 3
Across 2 paths, the API surfaces 3 operations — 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
User-defined settings for JupyterLab plugins.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from JupyterLab 6
Other APIs JupyterLab publishes across the network.