REST API¶
The same JupyterLab Server API spec, as found here, is available in an interactive form here (on swagger’s petstore). The OpenAPI Initiative (fka Swagger™) is a project used to describe and document RESTful APIs.
-
GET
/lab/api/listings/%40jupyterlab/extensionmanager-extension/listings.json
¶ Get Extension Listings Specs
Gets the list of extension metadata for the application
Example request:
GET /lab/api/listings/%40jupyterlab/extensionmanager-extension/listings.json HTTP/1.1 Host: example.com
- Status Codes
200 OK –
The Extension Listing specs
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "blocked_extension_uris": [ "string" ], "allowed_extension_uris": [ "string" ], "blocked_extensions": [ { "name": "string", "regexp": "string", "type": "string", "reason": "string", "creation_date": "string", "last_update_date": "string" } ], "allowed_extensions": [ { "name": "string", "regexp": "string", "type": "string", "reason": "string", "creation_date": "string", "last_update_date": "string" } ] }
-
GET
/lab/api/settings/
¶ Get Settings List
Gets the list of all application settings data
Example request:
GET /lab/api/settings/ HTTP/1.1 Host: example.com
- Status Codes
200 OK –
The Application Settings Data
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "settings": [ { "id": "string", "schema": {}, "version": "string", "raw": "string", "settings": {}, "warning": "string", "last_modified": "string", "created": "string" } ] }
-
GET
/lab/api/settings/{schema_name}
¶ Get the settings data for a given schema
Gets the settings data for a given schema
- Parameters
schema_name (string) – Schema Name
Example request:
GET /lab/api/settings/{schema_name} HTTP/1.1 Host: example.com
- Status Codes
200 OK –
The Settings Data
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "id": "string", "schema": {}, "version": "string", "raw": "string", "settings": {}, "warning": "string", "last_modified": "string", "created": "string" }
-
PUT
/lab/api/settings/{schema_name}
¶ Override the settings data for a given schema
Overrides the settings data for a given schema
- Parameters
schema_name (string) – Schema Name
Example request:
PUT /lab/api/settings/{schema_name} HTTP/1.1 Host: example.com Content-Type: application/json { "raw": "string" }
- Status Codes
204 No Content – The setting has been updated
-
GET
/lab/api/themes/{theme_file}
¶ Get a static theme file
Gets the static theme file at a given path
- Parameters
theme_file (string) – Theme file path
Example request:
GET /lab/api/themes/{theme_file} HTTP/1.1 Host: example.com
- Status Codes
200 OK – The Theme File
-
GET
/lab/api/translations/
¶ Get Translation Bundles
Gets the list of translation bundles
Example request:
GET /lab/api/translations/ HTTP/1.1 Host: example.com
- Status Codes
200 OK –
The Extension Listing specs
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "data": {}, "message": "string" }
-
GET
/lab/api/translations/{locale}
¶ Get the translation data for locale
Gets the translation data for a given locale
- Parameters
locale (string) – Locale name
Example request:
GET /lab/api/translations/{locale} HTTP/1.1 Host: example.com
- Status Codes
200 OK –
The Local Data
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "data": {}, "message": "string" }
-
GET
/lab/api/workspaces/
¶ Get Workspace Data
Gets the list of workspace data
Example request:
GET /lab/api/workspaces/ HTTP/1.1 Host: example.com
- Status Codes
200 OK –
The Workspace specs
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "workspaces": { "ids": [ "string" ], "values": [ { "data": {}, "metadata": { "id": "string", "last_modified": "string", "created": "string" } } ] } }
-
GET
/lab/api/workspaces/{space_name}
¶ Get the workspace data for name
Gets the workspace data for a given workspace name
- Parameters
space_name (string) – Workspace name
Example request:
GET /lab/api/workspaces/{space_name} HTTP/1.1 Host: example.com
- Status Codes
200 OK –
The Workspace Data
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "data": {}, "metadata": { "id": "string", "last_modified": "string", "created": "string" } }
-
PUT
/lab/api/workspaces/{space_name}
¶ Override the workspace data for a given name
Overrides the workspace data for a given workspace name
- Parameters
space_name (string) – Workspace name
Example request:
PUT /lab/api/workspaces/{space_name} HTTP/1.1 Host: example.com Content-Type: application/json { "data": {}, "metadata": { "id": "string", "last_modified": "string", "created": "string" } }
- Status Codes
204 No Content – The workspace has been updated
-
DELETE
/lab/api/workspaces/{space_name}
¶ Delete the workspace data for a given name
Deletes the workspace data for a given workspace name
- Parameters
space_name (string) – Workspace name
- Status Codes
204 No Content – The workspace has been deleted
-
GET
/lab/api/licenses/
¶ License report
Get the third-party licenses for the core application and all federated extensions
- Query Parameters
full_text (boolean) – Return full license texts
format (string) – The format in which to report licenses
bundles (string) – A regular expression to limit the names of bundles reported
download (boolean) – Whether to set a representative filename header
Example request:
GET /lab/api/licenses/ HTTP/1.1 Host: example.com
- Status Codes
200 OK –
A license report
Example response:
HTTP/1.1 200 OK Content-Type: application/json { "bundles": {} }