Apache Zeppelin Notebook Repository API

Overview

Apache Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality. All REST APIs are available starting with the following endpoint http://[zeppelin-server]:[zeppelin-port]/api. Note that Apache Zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as JSONView.

If you work with Apache Zeppelin and find a need for an additional REST API, please file an issue or send us an email.

Notebook Repository REST API List

List all available notebook repositories

Description This GET method returns all the available notebook repositories.
URL http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories
Success code 200
Fail code 500
Sample JSON response 
{
  "status": "OK",
  "message": "",
  "body": [
    {
      "name": "GitNotebookRepo",
      "className": "org.apache.zeppelin.notebook.repo.GitNotebookRepo",
      "settings": [
        {
          "type": "INPUT",
          "value": [],
          "selected": "ZEPPELIN_HOME/zeppelin/notebook/",
          "name": "Notebook Path"
        }
      ]
    }
  ]
}


Reload a notebook repository

Description This GET method triggers reloading and broadcasting of the note list.
URL http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories/reload
Success code 200
Fail code 500
Sample JSON response 
{
  "status": "OK",
  "message": ""
}


Update a specific notebook repository

Description This PUT method updates a specific notebook repository.
URL http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories
Success code 200
Fail code 404 when the specified notebook repository doesn't exist
406 for invalid payload
500 for any other errors
Sample JSON input 
{
  "name":"org.apache.zeppelin.notebook.repo.GitNotebookRepo",
  "settings":{
    "Notebook Path":"/tmp/notebook/"
  }
}
Sample JSON response 
{
  "status": "OK",
  "message": "",
  "body": {
    "name": "GitNotebookRepo",
    "className": "org.apache.zeppelin.notebook.repo.GitNotebookRepo",
    "settings": [
      {
        "type": "INPUT",
        "value": [],
        "selected": "/tmp/notebook/",
        "name": "Notebook Path"
      }
    ]
  }
}