Apache Zeppelin Interpreter REST 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.
Interpreter REST API List
The role of registered interpreters, settings and interpreters group are described in here.
List of registered interpreters
Description | This GET method returns 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 of registered interpreter settings
Description | This GET method returns 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" } ], "dependencies": [] }, |
Create a new 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" } ], "dependencies": [ { "groupArtifactVersion": "groupId:artifactId:version", "exclusions": "groupId:artifactId" } ] } |
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" } ], "dependencies": [ { "groupArtifactVersion": "groupId:artifactId:version", "exclusions": "groupId:artifactId" } ] } } |
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" } ], "dependencies": [ { "groupArtifactVersion": "groupId:artifactId:version", "exclusions": "groupId:artifactId" } ] } |
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" } ], "dependencies": [ { "groupArtifactVersion": "groupId:artifactId:version", "exclusions": "groupId:artifactId" } ] } } |
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 restarts 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"}
|
Add a new repository for dependency resolving
Description | This POST method adds new repository. |
URL | http://[zeppelin-server]:[zeppelin-port]/api/interpreter/repository |
Success code | 201 |
Fail code | 500 |
Sample JSON input |
{ "id": "securecentral", "url": "https://repo1.maven.org/maven2", "snapshot": false } |
Sample JSON response |
{"status":"OK"}
|
Delete a repository for dependency resolving
Description | This DELETE method delete repository with given id. |
URL | http://[zeppelin-server]:[zeppelin-port]/api/interpreter/repository/[repository ID] |
Success code | 200 |
Fail code | 500 |