JupyterLab

JupyterLab Settings API

User-defined settings for JupyterLab plugins.

GitHub OpenAPI

Operations 3

GET /settings JupyterLab List all settings #
GET /settings/{schema_name} JupyterLab Get setting #
PUT /settings/{schema_name} JupyterLab Update setting #

Documentation

📖
Documentation
https://jupyterlab-server.readthedocs.io/en/stable/api/rest.html

Specifications

⚙
OpenAPI
https://artifacts.apis.io/jupyterlab/openapi/jupyterlab-settings-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/jupyterlab/json-schema/jupyterlab-workspace.json
📊
JSONSchema
https://artifacts.apis.io/jupyterlab/json-schema/jupyterlab-setting.json

Other Resources

🔗
Repository
https://github.com/jupyterlab/jupyterlab_server
🔗
JSONLDContext
https://artifacts.apis.io/jupyterlab/json-ld/jupyterlab-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/jupyterlab:jupyterlab-settings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

jupyterlab-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: JupyterLab Server REST Settings API
  description: REST API for JupyterLab Server, the set of REST API services that JupyterLab depends on. Provides endpoints for managing user-defined settings, workspaces, themes, translations, third-party license reports, and extension listings. JupyterLab Server runs as a Jupyter Server extension.
  version: 2.27.0
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  contact:
    name: Jupyter Project
    url: https://jupyterlab.readthedocs.io
    email: jupyter@googlegroups.com
servers:
- url: http://localhost:8888/lab/api
  description: Local JupyterLab server
security:
- token: []
tags:
- name: Settings
  description: User-defined settings for JupyterLab plugins.
paths:
  /settings:
    get:
      operationId: listSettings
      summary: JupyterLab List all settings
      description: Returns a bundle of all application settings, suitable for the JupyterLab settings registry.
      tags:
      - Settings
      responses:
        '200':
          description: Bundle of all settings.
  /settings/{schema_name}:
    get:
      operationId: getSetting
      summary: JupyterLab Get setting
      description: Returns the user-defined settings for a single plugin schema.
      tags:
      - Settings
      parameters:
      - name: schema_name
        in: path
        required: true
        schema:
          type: string
        description: Plugin schema identifier (for example @jupyterlab/apputils-extension:themes).
      responses:
        '200':
          description: Settings document for the schema.
    put:
      operationId: updateSetting
      summary: JupyterLab Update setting
      description: Updates the user-defined settings for a single plugin schema.
      tags:
      - Settings
      parameters:
      - name: schema_name
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Setting updated.
components:
  securitySchemes:
    token:
      type: apiKey
      in: header
      name: Authorization
      description: 'Token-based authentication. Use the form: Authorization: token <token>'
    xsrf:
      type: apiKey
      in: header
      name: X-XSRFToken
      description: XSRF token required for browser-based requests.
externalDocs:
  description: JupyterLab Server REST API documentation
  url: https://jupyterlab-server.readthedocs.io/en/stable/api/rest.html