Jupyter Server Kernel

Schema for a kernel resource as returned by the Jupyter Server REST API.

ComputeInteractive ComputingKernelsNotebooksPortableWorkbooks

Properties

Name	Type	Description
id	string	Unique kernel identifier (UUID).
name	string	Kernel spec name (for example python3).
last_activity	string	ISO 8601 timestamp of the last kernel activity.
execution_state	string	Current execution state of the kernel.
connections	integer	Number of clients connected to this kernel.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/jupyter-server/main/json-schema/jupyter-server-kernel.json",
  "title": "Jupyter Server Kernel",
  "description": "Schema for a kernel resource as returned by the Jupyter Server REST API.",
  "type": "object",
  "required": ["id", "name"],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique kernel identifier (UUID)."
    },
    "name": {
      "type": "string",
      "description": "Kernel spec name (for example python3)."
    },
    "last_activity": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp of the last kernel activity."
    },
    "execution_state": {
      "type": "string",
      "enum": ["starting", "idle", "busy", "terminating", "restarting", "autorestarting", "dead"],
      "description": "Current execution state of the kernel."
    },
    "connections": {
      "type": "integer",
      "minimum": 0,
      "description": "Number of clients connected to this kernel."
    }
  }
}