Zeppelin REST API

Zeppelin provides several REST API's for interaction and remote activation of zeppelin functionality.

All REST API are available starting with the following endpoint http://[zeppelin-server]:[zeppelin-port]/api

Note that zeppein REST API receive or return JSON objects, it it recommended you install some JSON view such as JSONView

If you work with zeppelin and find a need for an additional REST API please file an issue or send us mail


Interpreter REST API list

The role of registered interpreters, settings and interpreters group is described here

List registered interpreters
Description This GET method return all the registered interpreters available on the server.
URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter
Success code 200
Fail code 500
sample JSON response 
{
  "status": "OK",
  "message": "",
  "body": {
    "md.md": {
      "name": "md",
      "group": "md",
      "className": "org.apache.zeppelin.markdown.Markdown",
      "properties": {},
      "path": "/zeppelin/interpreter/md"
    },
    "spark.spark": {
      "name": "spark",
      "group": "spark",
      "className": "org.apache.zeppelin.spark.SparkInterpreter",
      "properties": {
        "spark.executor.memory": {
          "defaultValue": "512m",
          "description": "Executor memory per worker instance. ex) 512m, 32g"
        },
        "spark.cores.max": {
          "defaultValue": "",
          "description": "Total number of cores to use. Empty value uses all available core."
        },
      },
      "path": "/zeppelin/interpreter/spark"
    },
    "spark.sql": {
      "name": "sql",
      "group": "spark",
      "className": "org.apache.zeppelin.spark.SparkSqlInterpreter",
      "properties": {
        "zeppelin.spark.maxResult": {
          "defaultValue": "1000",
          "description": "Max number of SparkSQL result to display."
        }
      },
      "path": "/zeppelin/interpreter/spark"
    }
  }
}


List interpreters settings
Description This GET method return all the interpreters settings registered on the server.
URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting
Success code 200
Fail code 500
sample JSON response 
{
  "status": "OK",
  "message": "",
  "body": [
    {
      "id": "2AYUGP2D5",
      "name": "md",
      "group": "md",
      "properties": {
        "empty": ""
      },
      "interpreterGroup": [
        {
          "class": "org.apache.zeppelin.markdown.Markdown",
          "name": "md"
        }
      ]
    },

    {
      "id": "2AY6GV7Q3",
      "name": "spark",
      "group": "spark",
      "properties": {
        "spark.cores.max": "",
        "spark.executor.memory": "512m",
      },
      "interpreterGroup": [
        {
          "class": "org.apache.zeppelin.spark.SparkInterpreter",
          "name": "spark"
        },
        {
          "class": "org.apache.zeppelin.spark.SparkSqlInterpreter",
          "name": "sql"
        }
      ]
    }
  ]
}


Create an interpreter setting
Description This POST method adds a new interpreter setting using a registered interpreter to the server.
URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting
Success code 201
Fail code 500
sample JSON input 
{
  "name": "Markdown setting name",
  "group": "md",
  "properties": {
    "propname": "propvalue"
  },
  "interpreterGroup": [
    {
      "class": "org.apache.zeppelin.markdown.Markdown",
      "name": "md"
    }
  ]
}
sample JSON response 
{
  "status": "CREATED",
  "message": "",
  "body": {
    "id": "2AYW25ANY",
    "name": "Markdown setting name",
    "group": "md",
    "properties": {
      "propname": "propvalue"
    },
    "interpreterGroup": [
      {
        "class": "org.apache.zeppelin.markdown.Markdown",
        "name": "md"
      }
    ]
  }
}


Update an interpreter setting
Description This PUT method updates an interpreter setting with new properties.
URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID]
Success code 200
Fail code 500
sample JSON input 
{
  "name": "Markdown setting name",
  "group": "md",
  "properties": {
    "propname": "Otherpropvalue"
  },
  "interpreterGroup": [
    {
      "class": "org.apache.zeppelin.markdown.Markdown",
      "name": "md"
    }
  ]
}
sample JSON response 
{
  "status": "OK",
  "message": "",
  "body": {
    "id": "2AYW25ANY",
    "name": "Markdown setting name",
    "group": "md",
    "properties": {
      "propname": "Otherpropvalue"
    },
    "interpreterGroup": [
      {
        "class": "org.apache.zeppelin.markdown.Markdown",
        "name": "md"
      }
    ]
  }
}


Delete an interpreter setting
Description This DELETE method deletes an given interpreter setting.
URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID]
Success code 200
Fail code 500
sample JSON response 
{"status":"OK"}


Restart an interpreter
Description This PUT method restart the given interpreter id.
URL http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/restart/[interpreter ID]
Success code 200
Fail code 500
sample JSON response 
{"status":"OK"}