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

JupyterLab Workspaces API

JupyterLab user workspaces.

JupyterLab Workspaces 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 Workspaces. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

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

4 operations 2 paths 0 schemas 1 DELETE2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

JupyterLab Workspaces 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 4

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

Workspaces 4

JupyterLab user workspaces.

GET
/workspaces
JupyterLab List workspaces
listWorkspaces → 200
GET
/workspaces/{space_name}
JupyterLab Get workspace
getWorkspace 1 param → 200
PUT
/workspaces/{space_name}
JupyterLab Update workspace
updateWorkspace 1 param → 204
DELETE
/workspaces/{space_name}
JupyterLab Delete workspace
deleteWorkspace 1 param → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jupyterlab-workspaces-api-openapi.yml Raw ↑

Other APIs JupyterLab publishes across the network.

JupyterLab Extension API
JupyterLab Licenses API
JupyterLab Listings API
JupyterLab Settings API
JupyterLab Themes API
JupyterLab Translations API