openapi: 3.1.0
info:
  title: Jupyter Notebook Jupyter Kernel Gateway Authorization Services API
  description: 'REST API for the Jupyter Kernel Gateway, a web server that provides headless access to Jupyter kernels. The Kernel Gateway supports two modes: jupyter-websocket mode (default) which provides a Jupyter Notebook server-compatible API for kernel management, and notebook-http mode which maps notebook cells to HTTP endpoints. This spec covers the jupyter-websocket mode API.'
  version: 3.0.0
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  contact:
    name: Jupyter Project
    url: https://jupyter-kernel-gateway.readthedocs.io
    email: jupyter@googlegroups.com
servers:
- url: http://localhost:8888/api
  description: Local Jupyter Kernel Gateway server
security:
- token: []
- tokenQuery: []
tags:
- name: Services
paths:
  /services:
    get:
      operationId: listServices
      summary: Jupyter Notebook List services
      description: List all registered JupyterHub services.
      tags:
      - Services
      responses:
        '200':
          description: List of services.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service'
        '403':
          description: Forbidden.
  /services/{name}:
    get:
      operationId: getService
      summary: Jupyter Notebook Get service details
      description: Get information about a specific service.
      tags:
      - Services
      parameters:
      - name: name
        in: path
        required: true
        description: Service name.
        schema:
          type: string
      responses:
        '200':
          description: Service details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Service'
        '404':
          description: Service not found.
components:
  schemas:
    Service:
      type: object
      description: A JupyterHub-managed service.
      properties:
        name:
          type: string
          description: Name of the service.
        admin:
          type: boolean
          description: Whether the service has admin access.
        url:
          type:
          - string
          - 'null'
          description: URL where the service is accessible.
        prefix:
          type: string
          description: URL prefix for the service.
        pid:
          type: integer
          description: Process ID if the service is a managed subprocess.
        command:
          type: array
          description: Command to launch the service.
          items:
            type: string
        info:
          type: object
          description: Additional service information.
          additionalProperties: true
        display:
          type: boolean
          description: Whether to display the service in the UI.
      required:
      - name
  securitySchemes:
    token:
      type: apiKey
      in: header
      name: Authorization
      description: Authentication token configured via KG_AUTH_TOKEN. Passed as 'token <token_value>' in the Authorization header.
    tokenQuery:
      type: apiKey
      in: query
      name: token
      description: Authentication token passed as a query parameter.