Apache Zeppelin 0.10.0 Documentation: Apache Zeppelin Interpreter REST API

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Apache Zeppelin 0.10.0 Documentation: Apache Zeppelin Interpreter REST API</title> <meta name="description" content="This page contains Apache Zeppelin Interpreter REST API information."> <meta name="author" content="The Apache Software Foundation">  <meta name="viewport" content="width=device-width, initial-scale=1.0">   <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet">  <link href="/docs/0.10.0/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet"> <link href="/docs/0.10.0/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css"> <link href="/docs/0.10.0/assets/themes/zeppelin/css/syntax.css" rel="stylesheet" type="text/css" media="screen" />    <script src="https://code.jquery.com/jquery-1.10.2.min.js"></script> <script src="/docs/0.10.0/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script> <script src="/docs/0.10.0/assets/themes/zeppelin/js/docs.js"></script> <script src="/docs/0.10.0/assets/themes/zeppelin/js/anchor.min.js"></script> <script src="/docs/0.10.0/assets/themes/zeppelin/js/toc.js"></script> <script src="/docs/0.10.0/assets/themes/zeppelin/js/lunr.min.js"></script> <script src="/docs/0.10.0/assets/themes/zeppelin/js/search.js"></script>  <link href="/docs/0.10.0/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed"> <link href="/docs/0.10.0/rss.xml" type="application/rss+xml" rel="alternate" title="Sitewide RSS Feed"> </head> <body> <div id="menu" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> <div class="container navbar-container"> <div class="navbar-header"> <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> Toggle navigation </button> <div class="navbar-brand"> <a class="navbar-brand-main" href="http://zeppelin.apache.org"> <img src="/docs/0.10.0/assets/themes/zeppelin/img/zeppelin_logo.png" width="50" style="margin-top: -2px;" alt="I'm zeppelin"> Zeppelin <a class="navbar-brand-version" href="/docs/0.10.0" style="font-size: 15px; color: white;"> 0.10.0 </a> </a> </div> </div> <nav class="navbar-collapse collapse" role="navigation"> <ul class="nav navbar-nav"> <li> <a href="#" data-toggle="dropdown" class="dropdown-toggle">Quick Start </a> <ul class="dropdown-menu"> <li class="title">Getting Started</li> <li><a href="/docs/0.10.0/quickstart/install.html">Install</a></li> <li><a href="/docs/0.10.0/quickstart/explore_ui.html">Explore UI</a></li> <li><a href="/docs/0.10.0/quickstart/tutorial.html">Tutorial</a></li> <li role="separator" class="divider"></li> <li class="title">Run Mode</li> <li><a href="/docs/0.10.0/quickstart/kubernetes.html">Kubernetes</a></li> <li><a href="/docs/0.10.0/quickstart/docker.html">Docker</a></li> <li><a href="/docs/0.10.0/quickstart/yarn.html">Yarn</a></li> <li role="separator" class="divider"></li> <li><a href="/docs/0.10.0/quickstart/spark_with_zeppelin.html">Spark with Zeppelin</a></li> <li><a href="/docs/0.10.0/quickstart/flink_with_zeppelin.html">Flink with Zeppelin</a></li> <li><a href="/docs/0.10.0/quickstart/sql_with_zeppelin.html">SQL with Zeppelin</a></li> <li><a href="/docs/0.10.0/quickstart/python_with_zeppelin.html">Python with Zeppelin</a></li> <li><a href="/docs/0.10.0/quickstart/r_with_zeppelin.html">R with Zeppelin</a></li> </ul> </li> <li> <a href="#" data-toggle="dropdown" class="dropdown-toggle">Usage</a> <ul class="dropdown-menu scrollable-menu"> <li class="title">Dynamic Form</li> <li><a href="/docs/0.10.0/usage/dynamic_form/intro.html">What is Dynamic Form?</a></li> <li role="separator" class="divider"></li> <li class="title">Display System</li> <li><a href="/docs/0.10.0/usage/display_system/basic.html#text">Text Display</a></li> <li><a href="/docs/0.10.0/usage/display_system/basic.html#html">HTML Display</a></li> <li><a href="/docs/0.10.0/usage/display_system/basic.html#table">Table Display</a></li> <li><a href="/docs/0.10.0/usage/display_system/basic.html#network">Network Display</a></li> <li><a href="/docs/0.10.0/usage/display_system/angular_backend.html">Angular Display using Backend API</a></li> <li><a href="/docs/0.10.0/usage/display_system/angular_frontend.html">Angular Display using Frontend API</a></li> <li role="separator" class="divider"></li> <li class="title">Interpreter</li> <li><a href="/docs/0.10.0/usage/interpreter/overview.html">Overview</a></li> <li><a href="/docs/0.10.0/usage/interpreter/interpreter_binding_mode.html">Interpreter Binding Mode</a></li> <li><a href="/docs/0.10.0/usage/interpreter/user_impersonation.html">User Impersonation</a></li> <li><a href="/docs/0.10.0/usage/interpreter/dependency_management.html">Dependency Management</a></li> <li><a href="/docs/0.10.0/usage/interpreter/installation.html">Installing Interpreters</a></li>  <li><a href="/docs/0.10.0/usage/interpreter/execution_hooks.html">Execution Hooks (Experimental)</a></li> <li role="separator" class="divider"></li> <li class="title">Other Features</li> <li><a href="/docs/0.10.0/usage/other_features/publishing_paragraphs.html">Publishing Paragraphs</a></li> <li><a href="/docs/0.10.0/usage/other_features/personalized_mode.html">Personalized Mode</a></li> <li><a href="/docs/0.10.0/usage/other_features/customizing_homepage.html">Customizing Zeppelin Homepage</a></li> <li><a href="/docs/0.10.0/usage/other_features/notebook_actions.html">Notebook Actions</a></li> <li><a href="/docs/0.10.0/usage/other_features/cron_scheduler.html">Cron Scheduler</a></li> <li><a href="/docs/0.10.0/usage/other_features/zeppelin_context.html">Zeppelin Context</a></li> <li role="separator" class="divider"></li> <li class="title">REST API</li> <li><a href="/docs/0.10.0/usage/rest_api/interpreter.html">Interpreter API</a></li> <li><a href="/docs/0.10.0/usage/rest_api/zeppelin_server.html">Zeppelin Server API</a></li> <li><a href="/docs/0.10.0/usage/rest_api/notebook.html">Notebook API</a></li> <li><a href="/docs/0.10.0/usage/rest_api/notebook_repository.html">Notebook Repository API</a></li> <li><a href="/docs/0.10.0/usage/rest_api/configuration.html">Configuration API</a></li> <li><a href="/docs/0.10.0/usage/rest_api/credential.html">Credential API</a></li> <li><a href="/docs/0.10.0/usage/rest_api/helium.html">Helium API</a></li> <li class="title">Zeppelin SDK</li> <li><a href="/docs/0.10.0/usage/zeppelin_sdk/client_api.html">Client API</a></li> <li><a href="/docs/0.10.0/usage/zeppelin_sdk/session_api.html">Session API</a></li> </ul> </li> <li> <a href="#" data-toggle="dropdown" class="dropdown-toggle">Setup</a> <ul class="dropdown-menu scrollable-menu"> <li class="title">Basics</li> <li><a href="/docs/0.10.0/setup/basics/how_to_build.html">How to Build Zeppelin</a></li> <li><a href="/docs/0.10.0/setup/basics/hadoop_integration.html">Hadoop Integration</a></li> <li><a href="/docs/0.10.0/setup/basics/multi_user_support.html">Multi-user Support</a></li> <li role="separator" class="divider"></li> <li class="title">Deployment</li>  <li><a href="/docs/0.10.0/setup/deployment/spark_cluster_mode.html#spark-standalone-mode">Spark Cluster Mode: Standalone</a></li> <li><a href="/docs/0.10.0/setup/deployment/spark_cluster_mode.html#spark-on-yarn-mode">Spark Cluster Mode: YARN</a></li> <li><a href="/docs/0.10.0/setup/deployment/spark_cluster_mode.html#spark-on-mesos-mode">Spark Cluster Mode: Mesos</a></li> <li><a href="/docs/0.10.0/setup/deployment/flink_and_spark_cluster.html">Zeppelin with Flink, Spark Cluster</a></li> <li><a href="/docs/0.10.0/setup/deployment/cdh.html">Zeppelin on CDH</a></li> <li><a href="/docs/0.10.0/setup/deployment/virtual_machine.html">Zeppelin on VM: Vagrant</a></li> <li role="separator" class="divider"></li> <li class="title">Security</li> <li><a href="/docs/0.10.0/setup/security/authentication_nginx.html">HTTP Basic Auth using NGINX</a></li> <li><a href="/docs/0.10.0/setup/security/shiro_authentication.html">Shiro Authentication</a></li> <li><a href="/docs/0.10.0/setup/security/notebook_authorization.html">Notebook Authorization</a></li> <li><a href="/docs/0.10.0/setup/security/datasource_authorization.html">Data Source Authorization</a></li> <li><a href="/docs/0.10.0/setup/security/http_security_headers.html">HTTP Security Headers</a></li> <li role="separator" class="divider"></li> <li class="title">Notebook Storage</li> <li><a href="/docs/0.10.0/setup/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li> <li><a href="/docs/0.10.0/setup/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li> <li><a href="/docs/0.10.0/setup/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li> <li><a href="/docs/0.10.0/setup/storage/storage.html#notebook-storage-in-oss">OSS Storage</a></li> <li><a href="/docs/0.10.0/setup/storage/storage.html#notebook-storage-in-zeppelinhub">ZeppelinHub Storage</a></li> <li><a href="/docs/0.10.0/setup/storage/storage.html#notebook-storage-in-mongodb">MongoDB Storage</a></li> <li role="separator" class="divider"></li> <li class="title">Operation</li> <li><a href="/docs/0.10.0/setup/operation/configuration.html">Configuration</a></li> <li><a href="/docs/0.10.0/setup/operation/proxy_setting.html">Proxy Setting</a></li> <li><a href="/docs/0.10.0/setup/operation/upgrading.html">Upgrading</a></li> <li><a href="/docs/0.10.0/setup/operation/trouble_shooting.html">Trouble Shooting</a></li> </ul> </li> <li> <a href="#" data-toggle="dropdown" class="dropdown-toggle">Interpreter </a> <ul class="dropdown-menu scrollable-menu"> <li class="title">Interpreters</li> <li><a href="/docs/0.10.0/usage/interpreter/overview.html">Overview</a></li> <li role="separator" class="divider"></li> <li><a href="/docs/0.10.0/interpreter/spark.html">Spark</a></li> <li><a href="/docs/0.10.0/interpreter/flink.html">Flink</a></li> <li><a href="/docs/0.10.0/interpreter/jdbc.html">JDBC</a></li> <li><a href="/docs/0.10.0/interpreter/python.html">Python</a></li> <li><a href="/docs/0.10.0/interpreter/r.html">R</a></li> <li role="separator" class="divider"></li> <li><a href="/docs/0.10.0/interpreter/alluxio.html">Alluxio</a></li> <li><a href="/docs/0.10.0/interpreter/beam.html">Beam</a></li> <li><a href="/docs/0.10.0/interpreter/bigquery.html">BigQuery</a></li> <li><a href="/docs/0.10.0/interpreter/cassandra.html">Cassandra</a></li> <li><a href="/docs/0.10.0/interpreter/elasticsearch.html">Elasticsearch</a></li> <li><a href="/docs/0.10.0/interpreter/geode.html">Geode</a></li> <li><a href="/docs/0.10.0/interpreter/groovy.html">Groovy</a></li> <li><a href="/docs/0.10.0/interpreter/hazelcastjet.html">Hazelcast Jet</a></li> <li><a href="/docs/0.10.0/interpreter/hbase.html">HBase</a></li> <li><a href="/docs/0.10.0/interpreter/hdfs.html">HDFS</a></li> <li><a href="/docs/0.10.0/interpreter/hive.html">Hive</a></li> <li><a href="/docs/0.10.0/interpreter/ignite.html">Ignite</a></li> <li><a href="/docs/0.10.0/interpreter/influxdb.html">influxDB</a></li> <li><a href="/docs/0.10.0/interpreter/java.html">Java</a></li> <li><a href="/docs/0.10.0/interpreter/jupyter.html">Jupyter</a></li> <li><a href="/docs/0.10.0/interpreter/kotlin.html">Kotlin</a></li> <li><a href="/docs/0.10.0/interpreter/ksql.html">KSQL</a></li> <li><a href="/docs/0.10.0/interpreter/kylin.html">Kylin</a></li> <li><a href="/docs/0.10.0/interpreter/lens.html">Lens</a></li> <li><a href="/docs/0.10.0/interpreter/livy.html">Livy</a></li> <li><a href="/docs/0.10.0/interpreter/mahout.html">Mahout</a></li> <li><a href="/docs/0.10.0/interpreter/markdown.html">Markdown</a></li> <li><a href="/docs/0.10.0/interpreter/mongodb.html">MongoDB</a></li> <li><a href="/docs/0.10.0/interpreter/neo4j.html">Neo4j</a></li> <li><a href="/docs/0.10.0/interpreter/pig.html">Pig</a></li> <li><a href="/docs/0.10.0/interpreter/postgresql.html">Postgresql, HAWQ</a></li> <li><a href="/docs/0.10.0/interpreter/sap.html">SAP</a></li> <li><a href="/docs/0.10.0/interpreter/scalding.html">Scalding</a></li> <li><a href="/docs/0.10.0/interpreter/scio.html">Scio</a></li> <li><a href="/docs/0.10.0/interpreter/shell.html">Shell</a></li> <li><a href="/docs/0.10.0/interpreter/sparql.html">Sparql</a></li> <li><a href="/docs/0.10.0/interpreter/submarine.html">Submarine</a></li> </ul> </li> <li> <a href="#" data-toggle="dropdown" class="dropdown-toggle">More</a> <ul class="dropdown-menu scrollable-menu" style="right: 0; left: auto;"> <li class="title">Extending Zeppelin</li> <li><a href="/docs/0.10.0/development/writing_zeppelin_interpreter.html">Writing Zeppelin Interpreter</a></li> <li role="separator" class="divider"></li> <li class="title">Helium (Experimental)</li> <li><a href="/docs/0.10.0/development/helium/overview.html">Overview</a></li> <li><a href="/docs/0.10.0/development/helium/writing_application.html">Writing Helium Application</a></li> <li><a href="/docs/0.10.0/development/helium/writing_spell.html">Writing Helium Spell</a></li> <li><a href="/docs/0.10.0/development/helium/writing_visualization_basic.html">Writing Helium Visualization: Basics</a></li> <li><a href="/docs/0.10.0/development/helium/writing_visualization_transformation.html">Writing Helium Visualization: Transformation</a></li> <li role="separator" class="divider"></li> <li class="title">Contributing to Zeppelin</li> <li><a href="/docs/0.10.0/setup/basics/how_to_build.html">How to Build Zeppelin</a></li> <li><a href="/docs/0.10.0/development/contribution/useful_developer_tools.html">Useful Developer Tools</a></li> <li><a href="/docs/0.10.0/development/contribution/how_to_contribute_code.html">How to Contribute (code)</a></li> <li><a href="/docs/0.10.0/development/contribution/how_to_contribute_website.html">How to Contribute (website)</a></li> <li role="separator" class="divider"></li> <li class="title">External Resources</li> <li><a target="_blank" href="https://zeppelin.apache.org/community.html">Mailing List</a></li> <li><a target="_blank" href="https://cwiki.apache.org/confluence/display/ZEPPELIN/Zeppelin+Home">Apache Zeppelin Wiki</a></li> <li><a target="_blank" href="http://stackoverflow.com/questions/tagged/apache-zeppelin">Stackoverflow Questions about Zeppelin</a></li> </ul> </li> <li> <a href="/docs/0.10.0/search.html" class="nav-search-link"> </a> </li> </ul> </nav> </div> </div> <div class="content">  <div class="row"> <div class="col-md-12">  <h1>Apache Zeppelin Interpreter REST API</h1> <div id="toc"></div> <h2>Overview</h2> Apache Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality. All REST APIs are available starting with the following endpoint <code>http://[zeppelin-server]:[zeppelin-port]/api</code>. Note that Apache Zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as <a href="https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc">JSONView</a>. If you work with Apache Zeppelin and find a need for an additional REST API, please <a href="http://zeppelin.apache.org/community.html">file an issue or send us an email</a>. <h2>Interpreter REST API List</h2> The role of registered interpreters, settings and interpreters group are described in <a href="../interpreter/overview.html">here</a>. <h3>List of registered interpreters</h3> <table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>GET</code> method returns all the registered interpreters available on the server.</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td>Fail code</td> <td> 500 </td> </tr> <tr> <td>Sample JSON response</td> <td> <div class="highlight"><pre><code class="json language-json" data-lang="json">{ "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": { "name": "spark.executor.memory", "defaultValue": "1g", "description": "Executor memory per worker instance. ex) 512m, 32g", "type": "string" }, "spark.cores.max": { "defaultValue": "", "description": "Total number of cores to use. Empty value uses all available core.", "type": "number" }, }, "path": "/zeppelin/interpreter/spark" }, "spark.sql": { "name": "sql", "group": "spark", "className": "org.apache.zeppelin.spark.SparkSqlInterpreter", "properties": { "zeppelin.spark.maxResult": { "name": "zeppelin.spark.maxResult", "defaultValue": "1000", "description": "Max number of Spark SQL result to display.", "type": "number" } }, "path": "/zeppelin/interpreter/spark" } } } </code></pre></div> </td> </tr> </table> <h3>List of registered interpreter settings</h3> <table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>GET</code> method returns all the interpreters settings registered on the server.</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td>Fail code</td> <td> 500 </td> </tr> <tr> <td>Sample JSON response</td> <td> <div class="highlight"><pre><code class="json language-json" data-lang="json">{ "status": "OK", "message": "", "body": [ { "id": "2AYUGP2D5", "name": "md", "group": "md", "properties": { "_empty_": "" }, "interpreterGroup": [ { "class": "org.apache.zeppelin.markdown.Markdown", "name": "md" } ], "dependencies": [] }, { "id": "2AY6GV7Q3", "name": "spark", "group": "spark", "properties": { "spark.cores.max": { "name": "", "value": "spark.cores.max", "type": "number" }, "spark.executor.memory": { "name": "spark.executor.memory", "value": "1g", "type": "string" } }, "interpreterGroup": [ { "class": "org.apache.zeppelin.spark.SparkInterpreter", "name": "spark" }, { "class": "org.apache.zeppelin.spark.SparkSqlInterpreter", "name": "sql" } ], "dependencies": [ { "groupArtifactVersion": "com.databricks:spark-csv_2.10:1.3.0" } ] } ] } </code></pre></div> </td> </tr> </table> <h3>Get a registered interpreter setting by the setting id</h3> <table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>GET</code> method returns a registered interpreter setting on the server.</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[setting ID]</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td>Fail code</td> <td> 400 if such interpreter setting id does not exist 500 for any other errors </td> </tr> <tr> <td>Sample JSON response</td> <td> <div class="highlight"><pre><code class="json language-json" data-lang="json">{ "status": "OK", "message": "", "body": { "id": "2AYW25ANY", "name": "Markdown setting name", "group": "md", "properties": { "propname": { "name": "propname", "value": "propvalue", "type": "textarea" } }, "interpreterGroup": [ { "class": "org.apache.zeppelin.markdown.Markdown", "name": "md" } ], "dependencies": [ { "groupArtifactVersion": "groupId:artifactId:version", "exclusions": [ "groupId:artifactId" ] } ] } } </code></pre></div> </td> </tr> </table> <h3>Create a new interpreter setting</h3> <table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>POST</code> method adds a new interpreter setting using a registered interpreter to the server.</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td>Fail code</td> <td> 400 if the input json is empty 500 for any other errors </td> </tr> <tr> <td>Sample JSON input</td> <td> <div class="highlight"><pre><code class="json language-json" data-lang="json">{ "name": "Markdown setting name", "group": "md", "properties": { "propname": { "name": "propname", "value": "propvalue", "type": "textarea" }, "interpreterGroup": [ { "class": "org.apache.zeppelin.markdown.Markdown", "name": "md" } ], "dependencies": [ { "groupArtifactVersion": "groupId:artifactId:version", "exclusions": [ "groupId:artifactId" ] } ] } </code></pre></div> </td> </tr> <tr> <td>Sample JSON response</td> <td> <div class="highlight"><pre><code class="json language-json" data-lang="json">{ "status": "OK", "message": "", "body": { "id": "2AYW25ANY", "name": "Markdown setting name", "group": "md", "properties": { "propname": { "name": "propname", "value": "propvalue", "type": "textarea" }, "interpreterGroup": [ { "class": "org.apache.zeppelin.markdown.Markdown", "name": "md" } ], "dependencies": [ { "groupArtifactVersion": "groupId:artifactId:version", "exclusions": [ "groupId:artifactId" ] } ] } } </code></pre></div> </td> </tr> </table> <h3>Update an interpreter setting</h3> <table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>PUT</code> method updates an interpreter setting with new properties.</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID]</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td>Fail code</td> <td> 500 </td> </tr> <tr> <td>Sample JSON input</td> <td> <div class="highlight"><pre><code class="json language-json" data-lang="json">{ "name": "Markdown setting name", "group": "md", "properties": { "propname": { "name": "propname", "value": "Otherpropvalue", "type": "textarea" }, "interpreterGroup": [ { "class": "org.apache.zeppelin.markdown.Markdown", "name": "md" } ], "dependencies": [ { "groupArtifactVersion": "groupId:artifactId:version", "exclusions": [ "groupId:artifactId" ] } ] } </code></pre></div> </td> </tr> <tr> <td>Sample JSON response</td> <td> <div class="highlight"><pre><code class="json language-json" data-lang="json">{ "status": "OK", "message": "", "body": { "id": "2AYW25ANY", "name": "Markdown setting name", "group": "md", "properties": { "propname": { "name": "propname", "value": "Otherpropvalue", "type": "textarea" }, "interpreterGroup": [ { "class": "org.apache.zeppelin.markdown.Markdown", "name": "md" } ], "dependencies": [ { "groupArtifactVersion": "groupId:artifactId:version", "exclusions": [ "groupId:artifactId" ] } ] } } </code></pre></div> </td> </tr> </table> <h3>Delete an interpreter setting</h3> <table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>DELETE</code> method deletes an given interpreter setting.</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID]</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td> Fail code</td> <td> 500 </td> </tr> <tr> <td>Sample JSON response</td> <td> <div class="highlight"><pre><code class="json language-json" data-lang="json">{"status":"OK"} </code></pre></div> </td> </tr> </table> <h3>Restart an interpreter</h3> <table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>PUT</code> method restarts the given interpreter id.</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/restart/[interpreter ID]</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td>Fail code</td> <td> 500 </td> </tr> <tr> <td>Sample JSON input (Optional)</td> <td> <div class="highlight"><pre><code class="json language-json" data-lang="json">{ "noteId": "2AVQJVC8N" } </code></pre></div> </td> </tr> <tr> <td>Sample JSON response</td> <td> <div class="highlight"><pre><code class="json language-json" data-lang="json">{"status":"OK"} </code></pre></div> </td> </tr> </table> <h3>Add a new repository for dependency resolving</h3> <table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>POST</code> method adds new repository.</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter/repository</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td>Fail code</td> <td> 500 </td> </tr> <tr> <td>Sample JSON input</td> <td> <div class="highlight"><pre><code class="json language-json" data-lang="json">{ "id": "securecentral", "url": "https://repo1.maven.org/maven2", "snapshot": false } </code></pre></div> </td> </tr> <tr> <td>Sample JSON response</td> <td> <div class="highlight"><pre><code class="json language-json" data-lang="json">{"status":"OK"} </code></pre></div> </td> </tr> </table> <h3>Delete a repository for dependency resolving</h3> <table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>DELETE</code> method delete repository with given id.</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter/repository/[repository ID]</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td>Fail code</td> <td> 500 </td> </tr> </table> <h3>Get available types for property</h3> <table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>GET</code> method returns available types for interpreter property.</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter/property/types</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td>Fail code</td> <td> 500 </td> </tr> <tr> <td>Sample JSON response</td> <td> <div class="highlight"><pre><code class="json language-json" data-lang="json">{ "status": "OK", "body": [ "textarea", "string", ... ] } </code></pre></div> </td> </td> </table> <h3>Get interpreter settings metadata info</h3> <table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>GET</code> method returns interpreter settings metadata info. </td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter/metadata/[setting ID]</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td>Fail code</td> <td> 500 </td> </tr> </table> </div> </div> <hr> <footer>  </footer> </div> <script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-45176241-5', 'zeppelin.apache.org'); ga('require', 'linkid', 'linkid.js'); ga('send', 'pageview'); </script> </body> </html>

CINXE.COM

Apache Zeppelin 0.10.0 Documentation: Apache Zeppelin Interpreter REST API