Jupyter Server Terminals API
Terminal session management.
Jupyter Server Terminals 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 Terminals. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a changelog, and 3 JSON Schemas.
This API exposes 4 operations across 2 paths. 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Jupyter Server Terminals 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 4
Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Terminal session management.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Jupyter Server 7
Other APIs Jupyter Server publishes across the network.