CINXE.COM
Apache Zeppelin 0.10.0 Documentation: Apache Zeppelin Helium REST API
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Apache Zeppelin 0.10.0 Documentation: Apache Zeppelin Helium REST API</title> <meta name="description" content="This page contains Apache Zeppelin Helium REST API information."> <meta name="author" content="The Apache Software Foundation"> <!-- Enable responsive viewport --> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <!-- Le HTML5 shim, for IE6-8 support of HTML elements --> <!--[if lt IE 9]> <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet"> <!-- Le styles --> <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" /> <!-- Le fav and touch icons --> <!-- Update these with your own images <link rel="shortcut icon" href="images/favicon.ico"> <link rel="apple-touch-icon" href="images/apple-touch-icon.png"> <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png"> <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png"> --> <!-- Js --> <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> <!-- atom & rss feed --> <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"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </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"> <span style="margin-left: 5px; font-size: 27px;">Zeppelin</span> <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 <b class="caret"></b></a> <ul class="dropdown-menu"> <li class="title"><span>Getting Started</span></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"><span>Run Mode</span></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<b class="caret"></b></a> <ul class="dropdown-menu scrollable-menu"> <li class="title"><span>Dynamic Form</span></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"><span>Display System</span></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"><span>Interpreter</span></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/dynamic_loading.html">Dynamic Interpreter Loading (Experimental)</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"><span>Other Features</span></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"><span>REST API</span></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"><span>Zeppelin SDK</span></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<b class="caret"></b></a> <ul class="dropdown-menu scrollable-menu"> <li class="title"><span>Basics</span></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"><span>Deployment</span></li> <!--<li><a href="/docs/0.10.0/setup/deployment/docker.html">Docker Image for Zeppelin</a></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"><span>Security</span></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"><span>Notebook Storage</span></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"><span>Operation</span></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 <b class="caret"></b></a> <ul class="dropdown-menu scrollable-menu"> <li class="title"><span>Interpreters</span></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<b class="caret"></b></a> <ul class="dropdown-menu scrollable-menu" style="right: 0; left: auto;"> <li class="title"><span>Extending Zeppelin</span></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"><span>Helium (Experimental)</span></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"><span>Contributing to Zeppelin</span></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"><span>External Resources</span></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"> <span class="fa fa-search nav-search-icon"></span> </a> </li> </ul> </nav><!--/.navbar-collapse --> </div> </div> <div class="content"> <!--<div class="hero-unit Apache Zeppelin Helium REST API"> <h1></h1> </div> --> <div class="row"> <div class="col-md-12"> <!-- Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <h1>Apache Zeppelin Helium REST API</h1> <div id="toc"></div> <h2>Overview</h2> <p>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>.</p> <p>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>.</p> <h2>Helium REST API List</h2> <h3>Get all available helium packages</h3> <p><table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>GET</code> method returns all the available helium packages in configured registries.</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/package</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></p> <div class="highlight"><pre><code class="json language-json" data-lang="json"><span class="p">{</span> <span class="nt">"status"</span><span class="p">:</span> <span class="s2">"OK"</span><span class="p">,</span> <span class="nt">"message"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="nt">"body"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"zeppelin.clock"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="nt">"registry"</span><span class="p">:</span> <span class="s2">"local"</span><span class="p">,</span> <span class="nt">"pkg"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"APPLICATION"</span><span class="p">,</span> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"zeppelin.clock"</span><span class="p">,</span> <span class="nt">"description"</span><span class="p">:</span> <span class="s2">"Clock (example)"</span><span class="p">,</span> <span class="nt">"artifact"</span><span class="p">:</span> <span class="s2">"zeppelin-examples\/zeppelin-example-clock\/target\/zeppelin-example</span> <span class="s2">-clock-0.7.0-SNAPSHOT.jar"</span><span class="p">,</span> <span class="nt">"className"</span><span class="p">:</span> <span class="s2">"org.apache.zeppelin.example.app.clock.Clock"</span><span class="p">,</span> <span class="nt">"resources"</span><span class="p">:</span> <span class="p">[</span> <span class="p">[</span> <span class="s2">":java.util.Date"</span> <span class="p">]</span> <span class="p">],</span> <span class="nt">"icon"</span><span class="p">:</span> <span class="s2">"icon"</span> <span class="p">},</span> <span class="nt">"enabled"</span><span class="p">:</span> <span class="kc">false</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> <span class="p">}</span> </code></pre></div> <p></td> </tr> </table> <br/></p> <h3>Get all enabled helium packages</h3> <p><table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>GET</code> method returns all enabled helium packages in configured registries.</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/enabledPackage</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></p> <div class="highlight"><pre><code class="json language-json" data-lang="json"><span class="p">{</span> <span class="nt">"status"</span><span class="p">:</span> <span class="s2">"OK"</span><span class="p">,</span> <span class="nt">"message"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="nt">"body"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"zeppelin.clock"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="nt">"registry"</span><span class="p">:</span> <span class="s2">"local"</span><span class="p">,</span> <span class="nt">"pkg"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"APPLICATION"</span><span class="p">,</span> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"zeppelin.clock"</span><span class="p">,</span> <span class="nt">"description"</span><span class="p">:</span> <span class="s2">"Clock (example)"</span><span class="p">,</span> <span class="nt">"artifact"</span><span class="p">:</span> <span class="s2">"zeppelin-examples\/zeppelin-example-clock\/target\/zeppelin-example</span> <span class="s2">-clock-0.7.0-SNAPSHOT.jar"</span><span class="p">,</span> <span class="nt">"className"</span><span class="p">:</span> <span class="s2">"org.apache.zeppelin.example.app.clock.Clock"</span><span class="p">,</span> <span class="nt">"resources"</span><span class="p">:</span> <span class="p">[</span> <span class="p">[</span> <span class="s2">":java.util.Date"</span> <span class="p">]</span> <span class="p">],</span> <span class="nt">"icon"</span><span class="p">:</span> <span class="s2">"icon"</span> <span class="p">},</span> <span class="nt">"enabled"</span><span class="p">:</span> <span class="kc">false</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> <span class="p">}</span> </code></pre></div> <p></td> </tr> </table> <br/></p> <h3>Get single helium package</h3> <p><table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>GET</code> method returns specified helium package information</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/package/[Package Name]</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></p> <div class="highlight"><pre><code class="json language-json" data-lang="json"><span class="p">{</span> <span class="nt">"status"</span><span class="p">:</span> <span class="s2">"OK"</span><span class="p">,</span> <span class="nt">"message"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="nt">"body"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"zeppelin.clock"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="nt">"registry"</span><span class="p">:</span> <span class="s2">"local"</span><span class="p">,</span> <span class="nt">"pkg"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"APPLICATION"</span><span class="p">,</span> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"zeppelin.clock"</span><span class="p">,</span> <span class="nt">"description"</span><span class="p">:</span> <span class="s2">"Clock (example)"</span><span class="p">,</span> <span class="nt">"artifact"</span><span class="p">:</span> <span class="s2">"zeppelin-examples\/zeppelin-example-clock\/target\/zeppelin-example</span> <span class="s2">-clock-0.7.0-SNAPSHOT.jar"</span><span class="p">,</span> <span class="nt">"className"</span><span class="p">:</span> <span class="s2">"org.apache.zeppelin.example.app.clock.Clock"</span><span class="p">,</span> <span class="nt">"resources"</span><span class="p">:</span> <span class="p">[</span> <span class="p">[</span> <span class="s2">":java.util.Date"</span> <span class="p">]</span> <span class="p">],</span> <span class="nt">"icon"</span><span class="p">:</span> <span class="s2">"icon"</span> <span class="p">},</span> <span class="nt">"enabled"</span><span class="p">:</span> <span class="kc">false</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> <span class="p">}</span> </code></pre></div> <p></td> </tr> </table> <br/></p> <h3>Suggest Helium package on a paragraph</h3> <p><table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>GET</code> method returns suggested helium package for the paragraph.</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/suggest/[Note ID]/[Paragraph ID]</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td>Fail code</td> <td> 404 on note or paragraph not exists <br /> 500 </td> </tr> <tr> <td>Sample JSON response</td> <td></p> <div class="highlight"><pre><code class="json language-json" data-lang="json"><span class="p">{</span> <span class="nt">"status"</span><span class="p">:</span> <span class="s2">"OK"</span><span class="p">,</span> <span class="nt">"message"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="nt">"body"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"available"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="nt">"registry"</span><span class="p">:</span> <span class="s2">"local"</span><span class="p">,</span> <span class="nt">"pkg"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"APPLICATION"</span><span class="p">,</span> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"zeppelin.clock"</span><span class="p">,</span> <span class="nt">"description"</span><span class="p">:</span> <span class="s2">"Clock (example)"</span><span class="p">,</span> <span class="nt">"artifact"</span><span class="p">:</span> <span class="s2">"zeppelin-examples\/zeppelin-example-clock\/target\/zeppelin-example</span> <span class="s2">-clock-0.7.0-SNAPSHOT.jar"</span><span class="p">,</span> <span class="nt">"className"</span><span class="p">:</span> <span class="s2">"org.apache.zeppelin.example.app.clock.Clock"</span><span class="p">,</span> <span class="nt">"resources"</span><span class="p">:</span> <span class="p">[</span> <span class="p">[</span> <span class="s2">":java.util.Date"</span> <span class="p">]</span> <span class="p">],</span> <span class="nt">"icon"</span><span class="p">:</span> <span class="s2">"icon"</span> <span class="p">},</span> <span class="nt">"enabled"</span><span class="p">:</span> <span class="kc">true</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> <span class="p">}</span> </code></pre></div> <p></td> </tr> </table> <br/></p> <h3>Load Helium package on a paragraph</h3> <p><table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>POST</code> method loads helium package to target paragraph.</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/load/[Note ID]/[Paragraph ID]</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td>Fail code</td> <td> 404 on note or paragraph not exists <br /> 500 </td> </tr> <tr> <td>Sample JSON response</td> <td></p> <div class="highlight"><pre><code class="json language-json" data-lang="json"><span class="p">{</span> <span class="nt">"status"</span><span class="p">:</span> <span class="s2">"OK"</span><span class="p">,</span> <span class="nt">"message"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="nt">"body"</span><span class="p">:</span> <span class="s2">"app_2C5FYRZ1E-20170108-040449_2068241472zeppelin_clock"</span> <span class="p">}</span> </code></pre></div> <p></td> </tr> </table> <br/></p> <h3>Load bundled visualization script</h3> <p><table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>GET</code> method returns bundled helium visualization javascript. When refresh=true (optional) is provided, Zeppelin rebuilds bundle. Otherwise, it's provided from cache</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/bundle/load/[Package Name][?refresh=true]</code></td> </tr> <tr> <td>Success code</td> <td>200 reponse body is executable javascript</td> </tr> <tr> <td>Fail code</td> <td> 200 reponse body is error message string starts with ERROR:<br/> </td> </tr> </table> <br/></p> <h3>Enable package</h3> <p><table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>POST</code> method enables a helium package. Needs artifact name in input payload</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/enable/[Package Name]</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td>Fail code</td> <td> 500 </td> </tr> <tr> <td>Sample input</td> <td> <pre> zeppelin-examples/zeppelin-example-clock/target/zeppelin-example-clock-0.7.0-SNAPSHOT.jar </pre> </td> </tr> <tr> <td>Sample JSON response</td> <td></p> <div class="highlight"><pre><code class="json language-json" data-lang="json"><span class="p">{</span><span class="nt">"status"</span><span class="p">:</span><span class="s2">"OK"</span><span class="p">}</span> </code></pre></div> <p></td> </tr> </table> <br/></p> <h3>Disable package</h3> <p><table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>POST</code> method disables a helium package.</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/disable/[Package Name]</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></p> <div class="highlight"><pre><code class="json language-json" data-lang="json"><span class="p">{</span><span class="nt">"status"</span><span class="p">:</span><span class="s2">"OK"</span><span class="p">}</span> </code></pre></div> <p></td> </tr> </table> <br/></p> <h3>Get visualization display order</h3> <p><table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>GET</code> method returns display order of enabled visualization packages.</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/order/visualization</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></p> <div class="highlight"><pre><code class="json language-json" data-lang="json"><span class="p">{</span><span class="nt">"status"</span><span class="p">:</span><span class="s2">"OK"</span><span class="p">,</span><span class="nt">"body"</span><span class="p">:[</span><span class="s2">"zeppelin_horizontalbar"</span><span class="p">,</span><span class="s2">"zeppelin-bubblechart"</span><span class="p">]}</span> </code></pre></div> <p></td> </tr> </table> <br/></p> <h3>Set visualization display order</h3> <p><table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>POST</code> method sets visualization packages display order.</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/order/visualization</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></p> <div class="highlight"><pre><code class="json language-json" data-lang="json"><span class="p">[</span><span class="s2">"zeppelin-bubblechart"</span><span class="p">,</span> <span class="s2">"zeppelin_horizontalbar"</span><span class="p">]</span> </code></pre></div> <p></td> </tr> <tr> <td>Sample JSON response</td> <td></p> <div class="highlight"><pre><code class="json language-json" data-lang="json"><span class="p">{</span><span class="nt">"status"</span><span class="p">:</span><span class="s2">"OK"</span><span class="p">}</span> </code></pre></div> <p></td> </tr> </table> <br/></p> <h3>Get configuration for all Helium packages</h3> <p><table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>GET</code> method returns configuration for all Helium packages</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/config</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td> Fail code</td> <td> 500 </td> </tr> </table> <br/></p> <p>### Get configuration for specific package</p> <p><table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>GET</code> method returns configuration for the specified package name and artifact</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/config/[Package Name]/[Artifact]</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td> Fail code</td> <td> 500 </td> </tr> </table> <br/></p> <h3>Set configuration for specific package</h3> <p><table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>POST</code> method updates configuration for specified package name and artifact</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/config/[Package Name]/[Artifact]</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td> Fail code</td> <td> 500 </td> </tr> </table><br> <br/></p> <p>### Get Spell configuration for single package</p> <p><table class="table-configuration"> <col width="200"> <tr> <td>Description</td> <td>This <code>GET</code> method returns specified package Spell configuration</td> </tr> <tr> <td>URL</td> <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/spell/config/[Package Name]</code></td> </tr> <tr> <td>Success code</td> <td>200</td> </tr> <tr> <td> Fail code</td> <td> 500 </td> </tr> </table> <br/></p> </div> </div> <hr> <footer> <!-- <p>© 2021 The Apache Software Foundation</p>--> </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>