Apache Zeppelin

Apache Zeppelin Notebook API

The Notebook API from Apache Zeppelin — 18 operation(s) for notebook.

Documentation GitHub OpenAPI

Operations 31

GET /api/notebook List notebooks

POST /api/notebook Create notebook

GET /api/notebook/{noteId} Get notebook

POST /api/notebook/{noteId} Run all paragraphs

DELETE /api/notebook/{noteId} Delete notebook

PUT /api/notebook/{noteId}/rename Rename notebook

PUT /api/notebook/{noteId}/clear Clear all paragraph results

GET /api/notebook/export/{noteId} Export notebook

POST /api/notebook/import Import notebook

GET /api/notebook/job/{noteId} Get notebook job status

DELETE /api/notebook/job/{noteId} Stop notebook job

GET /api/notebook/job/{noteId}/{paragraphId} Get paragraph job status

POST /api/notebook/job/{noteId}/{paragraphId} Run paragraph asynchronously

DELETE /api/notebook/job/{noteId}/{paragraphId} Stop paragraph job

POST /api/notebook/run/{noteId}/{paragraphId} Run paragraph synchronously

POST /api/notebook/{noteId}/paragraph Create paragraph

GET /api/notebook/{noteId}/paragraph/{paragraphId} Get paragraph

PUT /api/notebook/{noteId}/paragraph/{paragraphId} Update paragraph text

DELETE /api/notebook/{noteId}/paragraph/{paragraphId} Delete paragraph

PUT /api/notebook/{noteId}/paragraph/{paragraphId}/config Update paragraph config

POST /api/notebook/{noteId}/paragraph/{paragraphId}/move/{newIndex} Move paragraph to new index

GET /api/notebook/search Search notebooks

GET /api/notebook/cron/{noteId} Get cron schedule

POST /api/notebook/cron/{noteId} Register cron schedule

DELETE /api/notebook/cron/{noteId} Remove cron schedule

GET /api/notebook/{noteId}/permissions Get notebook permissions

PUT /api/notebook/{noteId}/permissions Update notebook permissions

GET /api/notebook/{noteId}/revision List revisions

POST /api/notebook/{noteId}/revision Create revision (commit)

GET /api/notebook/{noteId}/revision/{revisionId} Get specific revision

PUT /api/notebook/{noteId}/revision/{revisionId} Set notebook to a specific revision

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/apache-zeppelin-notebook-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Apache Zeppelin REST Notebook API
  version: '1.0'
  description: Minimal OpenAPI for the Apache Zeppelin notebook REST API covering notebook CRUD, paragraph management, scheduling (cron), permissions, revisions, jobs, and search.
servers:
- url: http://localhost:8080
  description: Zeppelin server
tags:
- name: Notebook
paths:
  /api/notebook:
    get:
      summary: List notebooks
      responses:
        '200':
          description: OK
      tags:
      - Notebook
    post:
      summary: Create notebook
      responses:
        '201':
          description: Created
      tags:
      - Notebook
  /api/notebook/{noteId}:
    get:
      summary: Get notebook
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
    post:
      summary: Run all paragraphs
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
    delete:
      summary: Delete notebook
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
  /api/notebook/{noteId}/rename:
    put:
      summary: Rename notebook
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
  /api/notebook/{noteId}/clear:
    put:
      summary: Clear all paragraph results
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
  /api/notebook/export/{noteId}:
    get:
      summary: Export notebook
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
  /api/notebook/import:
    post:
      summary: Import notebook
      responses:
        '200':
          description: OK
      tags:
      - Notebook
  /api/notebook/job/{noteId}:
    get:
      summary: Get notebook job status
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
    delete:
      summary: Stop notebook job
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
  /api/notebook/job/{noteId}/{paragraphId}:
    get:
      summary: Get paragraph job status
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      - name: paragraphId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
    post:
      summary: Run paragraph asynchronously
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      - name: paragraphId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
    delete:
      summary: Stop paragraph job
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      - name: paragraphId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
  /api/notebook/run/{noteId}/{paragraphId}:
    post:
      summary: Run paragraph synchronously
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      - name: paragraphId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
  /api/notebook/{noteId}/paragraph:
    post:
      summary: Create paragraph
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
      tags:
      - Notebook
  /api/notebook/{noteId}/paragraph/{paragraphId}:
    get:
      summary: Get paragraph
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      - name: paragraphId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
    put:
      summary: Update paragraph text
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      - name: paragraphId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
    delete:
      summary: Delete paragraph
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      - name: paragraphId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
  /api/notebook/{noteId}/paragraph/{paragraphId}/config:
    put:
      summary: Update paragraph config
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      - name: paragraphId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
  /api/notebook/{noteId}/paragraph/{paragraphId}/move/{newIndex}:
    post:
      summary: Move paragraph to new index
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      - name: paragraphId
        in: path
        required: true
        schema:
          type: string
      - name: newIndex
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
  /api/notebook/search:
    get:
      summary: Search notebooks
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
  /api/notebook/cron/{noteId}:
    get:
      summary: Get cron schedule
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
    post:
      summary: Register cron schedule
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
    delete:
      summary: Remove cron schedule
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
  /api/notebook/{noteId}/permissions:
    get:
      summary: Get notebook permissions
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
    put:
      summary: Update notebook permissions
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
  /api/notebook/{noteId}/revision:
    get:
      summary: List revisions
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
    post:
      summary: Create revision (commit)
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
  /api/notebook/{noteId}/revision/{revisionId}:
    get:
      summary: Get specific revision
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      - name: revisionId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
    put:
      summary: Set notebook to a specific revision
      parameters:
      - name: noteId
        in: path
        required: true
        schema:
          type: string
      - name: revisionId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notebook
x-generated-from: https://zeppelin.apache.org/docs/latest/usage/rest_api/notebook.html
x-generated-by: claude-crawl-2026-05-08