You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by mi...@apache.org on 2017/09/21 20:34:02 UTC
svn commit: r1809223 [24/30] - in /zeppelin/site: ./ contribution/
contribution/zeppelinweb/ docs/0.7.3/ docs/0.7.3/assets/
docs/0.7.3/assets/themes/ docs/0.7.3/assets/themes/zeppelin/
docs/0.7.3/assets/themes/zeppelin/bootstrap/ docs/0.7.3/assets/them...
Added: zeppelin/site/docs/0.7.3/rest-api/rest-configuration.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.3/rest-api/rest-configuration.html?rev=1809223&view=auto
==============================================================================
--- zeppelin/site/docs/0.7.3/rest-api/rest-configuration.html (added)
+++ zeppelin/site/docs/0.7.3/rest-api/rest-configuration.html Thu Sep 21 20:33:57 2017
@@ -0,0 +1,362 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Zeppelin 0.7.3 Documentation: Apache Zeppelin Configuration REST API</title>
+ <meta name="description" content="This page contains Apache Zeppelin Configuration 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.7.3/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+ <link href="/docs/0.7.3/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+ <link href="/docs/0.7.3/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.7.3/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/docs.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/anchor.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/toc.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/lunr.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/search.js"></script>
+
+ <!-- atom & rss feed -->
+ <link href="/docs/0.7.3/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/docs/0.7.3/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">
+ <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="/assets/themes/zeppelin/img/zeppelin_logo.png" width="50" alt="I'm zeppelin">
+ <span style="vertical-align:middle">Zeppelin</span>
+ </a>
+ <a class="navbar-brand-version" href="/docs/0.7.3">
+ <span><small>0.7.3</small></span>
+ </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><a href="/docs/0.7.3/index.html">What is Apache Zeppelin ?</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Getting Started</b><span></li>
+ <li><a href="/docs/0.7.3/install/install.html">Install</a></li>
+ <li><a href="/docs/0.7.3/install/configuration.html">Configuration</a></li>
+ <li><a href="/docs/0.7.3/quickstart/explorezeppelinui.html">Explore Zeppelin UI</a></li>
+ <li><a href="/docs/0.7.3/quickstart/tutorial.html">Tutorial</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Basic Feature Guide</b><span></li>
+ <li><a href="/docs/0.7.3/manual/dynamicform.html">Dynamic Form</a></li>
+ <li><a href="/docs/0.7.3/manual/publish.html">Publish your Paragraph</a></li>
+ <li><a href="/docs/0.7.3/manual/notebookashomepage.html">Customize Zeppelin Homepage</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>More</b><span></li>
+ <li><a href="/docs/0.7.3/install/upgrade.html">Upgrade Zeppelin Version</a></li>
+ <li><a href="/docs/0.7.3/install/build.html">Build from source</a></li>
+ <li><a href="/docs/0.7.3/quickstart/install_with_flink_and_spark_cluster.html">Install Zeppelin with Flink and Spark Clusters Tutorial</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><a href="/docs/0.7.3/manual/interpreters.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Usage</b><span></li>
+ <li><a href="/docs/0.7.3/manual/interpreterinstallation.html">Interpreter Installation</a></li>
+ <!--<li><a href="/docs/0.7.3/manual/dynamicinterpreterload.html">Dynamic Interpreter Loading</a></li>-->
+ <li><a href="/docs/0.7.3/manual/dependencymanagement.html">Interpreter Dependency Management</a></li>
+ <li><a href="/docs/0.7.3/manual/userimpersonation.html">Interpreter User Impersonation</a></li>
+ <li><a href="/docs/0.7.3/manual/interpreterexechooks.html">Interpreter Execution Hooks (Experimental)</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Available Interpreters</b><span></li>
+ <li><a href="/docs/0.7.3/interpreter/alluxio.html">Alluxio</a></li>
+ <li><a href="/docs/0.7.3/interpreter/beam.html">Beam</a></li>
+ <li><a href="/docs/0.7.3/interpreter/bigquery.html">BigQuery</a></li>
+ <li><a href="/docs/0.7.3/interpreter/cassandra.html">Cassandra</a></li>
+ <li><a href="/docs/0.7.3/interpreter/elasticsearch.html">Elasticsearch</a></li>
+ <li><a href="/docs/0.7.3/interpreter/flink.html">Flink</a></li>
+ <li><a href="/docs/0.7.3/interpreter/geode.html">Geode</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hbase.html">HBase</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hdfs.html">HDFS</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hive.html">Hive</a></li>
+ <li><a href="/docs/0.7.3/interpreter/ignite.html">Ignite</a></li>
+ <li><a href="/docs/0.7.3/interpreter/jdbc.html">JDBC</a></li>
+ <li><a href="/docs/0.7.3/interpreter/kylin.html">Kylin</a></li>
+ <li><a href="/docs/0.7.3/interpreter/lens.html">Lens</a></li>
+ <li><a href="/docs/0.7.3/interpreter/livy.html">Livy</a></li>
+ <li><a href="/docs/0.7.3/interpreter/markdown.html">Markdown</a></li>
+ <li><a href="/docs/0.7.3/interpreter/pig.html">Pig</a></li>
+ <li><a href="/docs/0.7.3/interpreter/python.html">Python</a></li>
+ <li><a href="/docs/0.7.3/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
+ <li><a href="/docs/0.7.3/interpreter/r.html">R</a></li>
+ <li><a href="/docs/0.7.3/interpreter/scalding.html">Scalding</a></li>
+ <li><a href="/docs/0.7.3/interpreter/scio.html">Scio</a></li>
+ <li><a href="/docs/0.7.3/interpreter/shell.html">Shell</a></li>
+ <li><a href="/docs/0.7.3/interpreter/spark.html">Spark</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Display System <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li class="title"><span><b>Basic Display System</b><span></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#text">Text</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#html">Html</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#table">Table</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Angular API</b><span></li>
+ <li><a href="/docs/0.7.3/displaysystem/back-end-angular.html">Angular (backend API)</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/front-end-angular.html">Angular (frontend API)</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><b>Notebook Storage</b><span></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>REST API</b><span></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-interpreter.html">Interpreter API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-configuration.html">Configuration API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-credential.html">Credential API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-helium.html">Helium API</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Security</b><span></li>
+ <li><a href="/docs/0.7.3/security/shiroauthentication.html">Shiro Authentication</a></li>
+ <li><a href="/docs/0.7.3/security/notebook_authorization.html">Notebook Authorization</a></li>
+ <li><a href="/docs/0.7.3/security/datasource_authorization.html">Data Source Authorization</a></li>
+ <li><a href="/docs/0.7.3/security/http_security_headers.html">HTTP Security Headers</a></li>
+ <li><a href="/docs/0.7.3/security/helium_authorization.html">Helium Authorization</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Advanced</b><span></li>
+ <li><a href="/docs/0.7.3/install/virtual_machine.html">Zeppelin on Vagrant VM</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-standalone-mode">Zeppelin on Spark Cluster Mode (Standalone)</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-yarn-mode">Zeppelin on Spark Cluster Mode (YARN)</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-mesos-mode">Zeppelin on Spark Cluster Mode (Mesos)</a></li>
+ <li><a href="/docs/0.7.3/install/cdh.html">Zeppelin on CDH</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Contibute</b><span></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelinvisualization.html">Writing Zeppelin Visualization (Experimental)</a></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelinapplication.html">Writing Zeppelin Application (Experimental)</a></li>
+ <li><a href="/docs/0.7.3/development/howtocontribute.html">How to contribute (code)</a></li>
+ <li><a href="/docs/0.7.3/development/howtocontributewebsite.html">How to contribute (website)</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="/docs/0.7.3/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 Configuration 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 Configuration 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>.
+nd a need for an additional REST API, please <a href="../../community.html">file an issue or send us mail</a>.</p>
+
+<h2>Configuration REST API list</h2>
+
+<h3>List all key/value pair of configurations</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method return all key/value pair of configurations on the server.<br/>
+ Note: For security reason, some pairs would not be shown.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/configurations/all</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>
+ <pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": {
+ "zeppelin.war.tempdir": "webapps",
+ "zeppelin.notebook.homescreen.hide": "false",
+ "zeppelin.interpreter.remoterunner": "bin/interpreter.sh",
+ "zeppelin.notebook.s3.user": "user",
+ "zeppelin.server.port": "8089",
+ "zeppelin.dep.localrepo": "local-repo",
+ "zeppelin.ssl.truststore.type": "JKS",
+ "zeppelin.ssl.keystore.path": "keystore",
+ "zeppelin.notebook.s3.bucket": "zeppelin",
+ "zeppelin.server.addr": "0.0.0.0",
+ "zeppelin.ssl.client.auth": "false",
+ "zeppelin.server.context.path": "/",
+ "zeppelin.ssl.keystore.type": "JKS",
+ "zeppelin.ssl.truststore.path": "truststore",
+ "zeppelin.interpreters": "org.apache.zeppelin.spark.SparkInterpreter,org.apache.zeppelin.spark.PySparkInterpreter,org.apache.zeppelin.spark.SparkRInterpreter,org.apache.zeppelin.spark.SparkSqlInterpreter,org.apache.zeppelin.spark.DepInterpreter,org.apache.zeppelin.markdown.Markdown,org.apache.zeppelin.angular.AngularInterpreter,org.apache.zeppelin.shell.ShellInterpreter,org.apache.zeppelin.flink.FlinkInterpreter,org.apache.zeppelin.lens.LensInterpreter,org.apache.zeppelin.ignite.IgniteInterpreter,org.apache.zeppelin.ignite.IgniteSqlInterpreter,org.apache.zeppelin.cassandra.CassandraInterpreter,org.apache.zeppelin.geode.GeodeOqlInterpreter,org.apache.zeppelin.postgresql.PostgreSqlInterpreter,org.apache.zeppelin.kylin.KylinInterpreter,org.apache.zeppelin.elasticsearch.ElasticsearchInterpreter,org.apache.zeppelin.scalding.ScaldingInterpreter",
+ "zeppelin.ssl": "false",
+ "zeppelin.notebook.autoInterpreterBinding": "true",
+ "zeppelin.notebook.homescreen": "",
+ "zeppelin.notebook.storage": "org.apache.zeppelin.notebook.repo.VFSNotebookRepo",
+ "zeppelin.interpreter.connect.timeout": "30000",
+ "zeppelin.anonymous.allowed": "true",
+ "zeppelin.server.allowed.origins":"*",
+ "zeppelin.encoding": "UTF-8"
+ }
+}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>List all prefix matched key/value pair of configurations</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method return all prefix matched key/value pair of configurations on the server.<br/>
+ Note: For security reason, some pairs would not be shown.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/configurations/prefix/[prefix]</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><pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": {
+ "zeppelin.ssl.keystore.type": "JKS",
+ "zeppelin.ssl.truststore.path": "truststore",
+ "zeppelin.ssl.truststore.type": "JKS",
+ "zeppelin.ssl.keystore.path": "keystore",
+ "zeppelin.ssl": "false",
+ "zeppelin.ssl.client.auth": "false"
+ }
+}</pre>
+ </td>
+ </tr>
+ </table></p>
+
+ </div>
+</div>
+
+
+ <hr>
+ <footer>
+ <!-- <p>© 2017 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>
+
Added: zeppelin/site/docs/0.7.3/rest-api/rest-credential.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.3/rest-api/rest-credential.html?rev=1809223&view=auto
==============================================================================
--- zeppelin/site/docs/0.7.3/rest-api/rest-credential.html (added)
+++ zeppelin/site/docs/0.7.3/rest-api/rest-credential.html Thu Sep 21 20:33:57 2017
@@ -0,0 +1,414 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Zeppelin 0.7.3 Documentation: Apache Zeppelin Credential REST API</title>
+ <meta name="description" content="This page contains Apache Zeppelin Credential 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.7.3/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+ <link href="/docs/0.7.3/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+ <link href="/docs/0.7.3/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.7.3/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/docs.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/anchor.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/toc.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/lunr.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/search.js"></script>
+
+ <!-- atom & rss feed -->
+ <link href="/docs/0.7.3/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/docs/0.7.3/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">
+ <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="/assets/themes/zeppelin/img/zeppelin_logo.png" width="50" alt="I'm zeppelin">
+ <span style="vertical-align:middle">Zeppelin</span>
+ </a>
+ <a class="navbar-brand-version" href="/docs/0.7.3">
+ <span><small>0.7.3</small></span>
+ </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><a href="/docs/0.7.3/index.html">What is Apache Zeppelin ?</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Getting Started</b><span></li>
+ <li><a href="/docs/0.7.3/install/install.html">Install</a></li>
+ <li><a href="/docs/0.7.3/install/configuration.html">Configuration</a></li>
+ <li><a href="/docs/0.7.3/quickstart/explorezeppelinui.html">Explore Zeppelin UI</a></li>
+ <li><a href="/docs/0.7.3/quickstart/tutorial.html">Tutorial</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Basic Feature Guide</b><span></li>
+ <li><a href="/docs/0.7.3/manual/dynamicform.html">Dynamic Form</a></li>
+ <li><a href="/docs/0.7.3/manual/publish.html">Publish your Paragraph</a></li>
+ <li><a href="/docs/0.7.3/manual/notebookashomepage.html">Customize Zeppelin Homepage</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>More</b><span></li>
+ <li><a href="/docs/0.7.3/install/upgrade.html">Upgrade Zeppelin Version</a></li>
+ <li><a href="/docs/0.7.3/install/build.html">Build from source</a></li>
+ <li><a href="/docs/0.7.3/quickstart/install_with_flink_and_spark_cluster.html">Install Zeppelin with Flink and Spark Clusters Tutorial</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><a href="/docs/0.7.3/manual/interpreters.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Usage</b><span></li>
+ <li><a href="/docs/0.7.3/manual/interpreterinstallation.html">Interpreter Installation</a></li>
+ <!--<li><a href="/docs/0.7.3/manual/dynamicinterpreterload.html">Dynamic Interpreter Loading</a></li>-->
+ <li><a href="/docs/0.7.3/manual/dependencymanagement.html">Interpreter Dependency Management</a></li>
+ <li><a href="/docs/0.7.3/manual/userimpersonation.html">Interpreter User Impersonation</a></li>
+ <li><a href="/docs/0.7.3/manual/interpreterexechooks.html">Interpreter Execution Hooks (Experimental)</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Available Interpreters</b><span></li>
+ <li><a href="/docs/0.7.3/interpreter/alluxio.html">Alluxio</a></li>
+ <li><a href="/docs/0.7.3/interpreter/beam.html">Beam</a></li>
+ <li><a href="/docs/0.7.3/interpreter/bigquery.html">BigQuery</a></li>
+ <li><a href="/docs/0.7.3/interpreter/cassandra.html">Cassandra</a></li>
+ <li><a href="/docs/0.7.3/interpreter/elasticsearch.html">Elasticsearch</a></li>
+ <li><a href="/docs/0.7.3/interpreter/flink.html">Flink</a></li>
+ <li><a href="/docs/0.7.3/interpreter/geode.html">Geode</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hbase.html">HBase</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hdfs.html">HDFS</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hive.html">Hive</a></li>
+ <li><a href="/docs/0.7.3/interpreter/ignite.html">Ignite</a></li>
+ <li><a href="/docs/0.7.3/interpreter/jdbc.html">JDBC</a></li>
+ <li><a href="/docs/0.7.3/interpreter/kylin.html">Kylin</a></li>
+ <li><a href="/docs/0.7.3/interpreter/lens.html">Lens</a></li>
+ <li><a href="/docs/0.7.3/interpreter/livy.html">Livy</a></li>
+ <li><a href="/docs/0.7.3/interpreter/markdown.html">Markdown</a></li>
+ <li><a href="/docs/0.7.3/interpreter/pig.html">Pig</a></li>
+ <li><a href="/docs/0.7.3/interpreter/python.html">Python</a></li>
+ <li><a href="/docs/0.7.3/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
+ <li><a href="/docs/0.7.3/interpreter/r.html">R</a></li>
+ <li><a href="/docs/0.7.3/interpreter/scalding.html">Scalding</a></li>
+ <li><a href="/docs/0.7.3/interpreter/scio.html">Scio</a></li>
+ <li><a href="/docs/0.7.3/interpreter/shell.html">Shell</a></li>
+ <li><a href="/docs/0.7.3/interpreter/spark.html">Spark</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Display System <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li class="title"><span><b>Basic Display System</b><span></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#text">Text</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#html">Html</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#table">Table</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Angular API</b><span></li>
+ <li><a href="/docs/0.7.3/displaysystem/back-end-angular.html">Angular (backend API)</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/front-end-angular.html">Angular (frontend API)</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><b>Notebook Storage</b><span></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>REST API</b><span></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-interpreter.html">Interpreter API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-configuration.html">Configuration API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-credential.html">Credential API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-helium.html">Helium API</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Security</b><span></li>
+ <li><a href="/docs/0.7.3/security/shiroauthentication.html">Shiro Authentication</a></li>
+ <li><a href="/docs/0.7.3/security/notebook_authorization.html">Notebook Authorization</a></li>
+ <li><a href="/docs/0.7.3/security/datasource_authorization.html">Data Source Authorization</a></li>
+ <li><a href="/docs/0.7.3/security/http_security_headers.html">HTTP Security Headers</a></li>
+ <li><a href="/docs/0.7.3/security/helium_authorization.html">Helium Authorization</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Advanced</b><span></li>
+ <li><a href="/docs/0.7.3/install/virtual_machine.html">Zeppelin on Vagrant VM</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-standalone-mode">Zeppelin on Spark Cluster Mode (Standalone)</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-yarn-mode">Zeppelin on Spark Cluster Mode (YARN)</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-mesos-mode">Zeppelin on Spark Cluster Mode (Mesos)</a></li>
+ <li><a href="/docs/0.7.3/install/cdh.html">Zeppelin on CDH</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Contibute</b><span></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelinvisualization.html">Writing Zeppelin Visualization (Experimental)</a></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelinapplication.html">Writing Zeppelin Application (Experimental)</a></li>
+ <li><a href="/docs/0.7.3/development/howtocontribute.html">How to contribute (code)</a></li>
+ <li><a href="/docs/0.7.3/development/howtocontributewebsite.html">How to contribute (website)</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="/docs/0.7.3/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 Credential 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 Credential 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>
+
+<p><br /></p>
+
+<h2>Credential REST API List</h2>
+
+<h3>List Credential information</h3>
+
+<p><table class="table-credential">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method returns all key/value pairs of the credential information on the server.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/credential</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>
+ <pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": {
+ "userCredentials":{
+ "entity1":{
+ "username":"user1",
+ "password":"password1"
+ },
+ "entity2":{
+ "username":"user2",
+ "password":"password2"
+ }
+ }
+ }
+}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Create an Credential Information</h3>
+
+<p><table class="table-credential">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>PUT</code> method creates the credential information with new properties.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/credential/</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>
+ <pre>
+{
+ "entity": "e1",
+ "username": "user",
+ "password": "password"
+}
+ </pre>
+ </td>
+ </tr>
+ <tr>
+ <td>Sample JSON response</td>
+ <td>
+ <pre>
+{
+ "status": "OK"
+}
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Delete all Credential Information</h3>
+
+<p><table class="table-credential">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>DELETE</code> method deletes the credential information.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/credential</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>
+ <code>{"status":"OK"}</code>
+ </td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Delete an Credential entity</h3>
+
+<p><table class="table-credential">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>DELETE</code> method deletes a given credential entity.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/credential/[entity]</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>
+ <code>{"status":"OK"}</code>
+ </td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+ </div>
+</div>
+
+
+ <hr>
+ <footer>
+ <!-- <p>© 2017 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>
+
Added: zeppelin/site/docs/0.7.3/rest-api/rest-helium.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.7.3/rest-api/rest-helium.html?rev=1809223&view=auto
==============================================================================
--- zeppelin/site/docs/0.7.3/rest-api/rest-helium.html (added)
+++ zeppelin/site/docs/0.7.3/rest-api/rest-helium.html Thu Sep 21 20:33:57 2017
@@ -0,0 +1,610 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Apache Zeppelin 0.7.3 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.7.3/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+ <link href="/docs/0.7.3/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+ <link href="/docs/0.7.3/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.7.3/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/docs.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/anchor.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/toc.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/lunr.min.js"></script>
+ <script src="/docs/0.7.3/assets/themes/zeppelin/js/search.js"></script>
+
+ <!-- atom & rss feed -->
+ <link href="/docs/0.7.3/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/docs/0.7.3/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">
+ <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="/assets/themes/zeppelin/img/zeppelin_logo.png" width="50" alt="I'm zeppelin">
+ <span style="vertical-align:middle">Zeppelin</span>
+ </a>
+ <a class="navbar-brand-version" href="/docs/0.7.3">
+ <span><small>0.7.3</small></span>
+ </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><a href="/docs/0.7.3/index.html">What is Apache Zeppelin ?</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Getting Started</b><span></li>
+ <li><a href="/docs/0.7.3/install/install.html">Install</a></li>
+ <li><a href="/docs/0.7.3/install/configuration.html">Configuration</a></li>
+ <li><a href="/docs/0.7.3/quickstart/explorezeppelinui.html">Explore Zeppelin UI</a></li>
+ <li><a href="/docs/0.7.3/quickstart/tutorial.html">Tutorial</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Basic Feature Guide</b><span></li>
+ <li><a href="/docs/0.7.3/manual/dynamicform.html">Dynamic Form</a></li>
+ <li><a href="/docs/0.7.3/manual/publish.html">Publish your Paragraph</a></li>
+ <li><a href="/docs/0.7.3/manual/notebookashomepage.html">Customize Zeppelin Homepage</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>More</b><span></li>
+ <li><a href="/docs/0.7.3/install/upgrade.html">Upgrade Zeppelin Version</a></li>
+ <li><a href="/docs/0.7.3/install/build.html">Build from source</a></li>
+ <li><a href="/docs/0.7.3/quickstart/install_with_flink_and_spark_cluster.html">Install Zeppelin with Flink and Spark Clusters Tutorial</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><a href="/docs/0.7.3/manual/interpreters.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Usage</b><span></li>
+ <li><a href="/docs/0.7.3/manual/interpreterinstallation.html">Interpreter Installation</a></li>
+ <!--<li><a href="/docs/0.7.3/manual/dynamicinterpreterload.html">Dynamic Interpreter Loading</a></li>-->
+ <li><a href="/docs/0.7.3/manual/dependencymanagement.html">Interpreter Dependency Management</a></li>
+ <li><a href="/docs/0.7.3/manual/userimpersonation.html">Interpreter User Impersonation</a></li>
+ <li><a href="/docs/0.7.3/manual/interpreterexechooks.html">Interpreter Execution Hooks (Experimental)</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Available Interpreters</b><span></li>
+ <li><a href="/docs/0.7.3/interpreter/alluxio.html">Alluxio</a></li>
+ <li><a href="/docs/0.7.3/interpreter/beam.html">Beam</a></li>
+ <li><a href="/docs/0.7.3/interpreter/bigquery.html">BigQuery</a></li>
+ <li><a href="/docs/0.7.3/interpreter/cassandra.html">Cassandra</a></li>
+ <li><a href="/docs/0.7.3/interpreter/elasticsearch.html">Elasticsearch</a></li>
+ <li><a href="/docs/0.7.3/interpreter/flink.html">Flink</a></li>
+ <li><a href="/docs/0.7.3/interpreter/geode.html">Geode</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hbase.html">HBase</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hdfs.html">HDFS</a></li>
+ <li><a href="/docs/0.7.3/interpreter/hive.html">Hive</a></li>
+ <li><a href="/docs/0.7.3/interpreter/ignite.html">Ignite</a></li>
+ <li><a href="/docs/0.7.3/interpreter/jdbc.html">JDBC</a></li>
+ <li><a href="/docs/0.7.3/interpreter/kylin.html">Kylin</a></li>
+ <li><a href="/docs/0.7.3/interpreter/lens.html">Lens</a></li>
+ <li><a href="/docs/0.7.3/interpreter/livy.html">Livy</a></li>
+ <li><a href="/docs/0.7.3/interpreter/markdown.html">Markdown</a></li>
+ <li><a href="/docs/0.7.3/interpreter/pig.html">Pig</a></li>
+ <li><a href="/docs/0.7.3/interpreter/python.html">Python</a></li>
+ <li><a href="/docs/0.7.3/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
+ <li><a href="/docs/0.7.3/interpreter/r.html">R</a></li>
+ <li><a href="/docs/0.7.3/interpreter/scalding.html">Scalding</a></li>
+ <li><a href="/docs/0.7.3/interpreter/scio.html">Scio</a></li>
+ <li><a href="/docs/0.7.3/interpreter/shell.html">Shell</a></li>
+ <li><a href="/docs/0.7.3/interpreter/spark.html">Spark</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Display System <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li class="title"><span><b>Basic Display System</b><span></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#text">Text</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#html">Html</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/basicdisplaysystem.html#table">Table</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Angular API</b><span></li>
+ <li><a href="/docs/0.7.3/displaysystem/back-end-angular.html">Angular (backend API)</a></li>
+ <li><a href="/docs/0.7.3/displaysystem/front-end-angular.html">Angular (frontend API)</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><b>Notebook Storage</b><span></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li>
+ <li><a href="/docs/0.7.3/storage/storage.html#storage-in-zeppelinhub">ZeppelinHub Storage</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>REST API</b><span></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-interpreter.html">Interpreter API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-notebookRepo.html">Notebook Repository API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-configuration.html">Configuration API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-credential.html">Credential API</a></li>
+ <li><a href="/docs/0.7.3/rest-api/rest-helium.html">Helium API</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Security</b><span></li>
+ <li><a href="/docs/0.7.3/security/shiroauthentication.html">Shiro Authentication</a></li>
+ <li><a href="/docs/0.7.3/security/notebook_authorization.html">Notebook Authorization</a></li>
+ <li><a href="/docs/0.7.3/security/datasource_authorization.html">Data Source Authorization</a></li>
+ <li><a href="/docs/0.7.3/security/http_security_headers.html">HTTP Security Headers</a></li>
+ <li><a href="/docs/0.7.3/security/helium_authorization.html">Helium Authorization</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Advanced</b><span></li>
+ <li><a href="/docs/0.7.3/install/virtual_machine.html">Zeppelin on Vagrant VM</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-standalone-mode">Zeppelin on Spark Cluster Mode (Standalone)</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-yarn-mode">Zeppelin on Spark Cluster Mode (YARN)</a></li>
+ <li><a href="/docs/0.7.3/install/spark_cluster_mode.html#spark-on-mesos-mode">Zeppelin on Spark Cluster Mode (Mesos)</a></li>
+ <li><a href="/docs/0.7.3/install/cdh.html">Zeppelin on CDH</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="title"><span><b>Contibute</b><span></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelinvisualization.html">Writing Zeppelin Visualization (Experimental)</a></li>
+ <li><a href="/docs/0.7.3/development/writingzeppelinapplication.html">Writing Zeppelin Application (Experimental)</a></li>
+ <li><a href="/docs/0.7.3/development/howtocontribute.html">How to contribute (code)</a></li>
+ <li><a href="/docs/0.7.3/development/howtocontributewebsite.html">How to contribute (website)</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="/docs/0.7.3/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>List of 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/all</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>
+ <pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": {
+ "zeppelin.clock": [
+ {
+ "registry": "local",
+ "pkg": {
+ "type": "APPLICATION",
+ "name": "zeppelin.clock",
+ "description": "Clock (example)",
+ "artifact": "zeppelin-examples\/zeppelin-example-clock\/target\/zeppelin-example-clock-0.7.0-SNAPSHOT.jar",
+ "className": "org.apache.zeppelin.example.app.clock.Clock",
+ "resources": [
+ [
+ ":java.util.Date"
+ ]
+ ],
+ "icon": "icon"
+ },
+ "enabled": false
+ }
+ ],
+ "zeppelin-bubblechart": [
+ {
+ "registry": "local",
+ "pkg": {
+ "type": "VISUALIZATION",
+ "name": "zeppelin-bubblechart",
+ "description": "Animated bubble chart",
+ "artifact": ".\/..\/helium\/zeppelin-bubble",
+ "icon": "icon"
+ },
+ "enabled": true
+ },
+ {
+ "registry": "local",
+ "pkg": {
+ "type": "VISUALIZATION",
+ "name": "zeppelin-bubblechart",
+ "description": "Animated bubble chart",
+ "artifact": "zeppelin-bubblechart@0.0.2",
+ "icon": "icon"
+ },
+ "enabled": false
+ }
+ ],
+ "zeppelin_horizontalbar": [
+ {
+ "registry": "local",
+ "pkg": {
+ "type": "VISUALIZATION",
+ "name": "zeppelin_horizontalbar",
+ "description": "Horizontal Bar chart (example)",
+ "artifact": ".\/zeppelin-examples\/zeppelin-example-horizontalbar",
+ "icon": "icon"
+ },
+ "enabled": true
+ }
+ ]
+ }
+}
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Suggest Helium application</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method returns suggested helium application 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>
+ <pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": {
+ "available": [
+ {
+ "registry": "local",
+ "pkg": {
+ "type": "APPLICATION",
+ "name": "zeppelin.clock",
+ "description": "Clock (example)",
+ "artifact": "zeppelin-examples\/zeppelin-example-clock\/target\/zeppelin-example-clock-0.7.0-SNAPSHOT.jar",
+ "className": "org.apache.zeppelin.example.app.clock.Clock",
+ "resources": [
+ [
+ ":java.util.Date"
+ ]
+ ],
+ "icon": "icon"
+ },
+ "enabled": true
+ }
+ ]
+ }
+}
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<h3>Load helium Application on a paragraph</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method returns a helium Application id on success.</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 for any other errors
+ </td>
+ </tr>
+ <tr>
+ <td>Sample JSON response</td>
+ <td>
+ <pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": "app<em>2C5FYRZ1E-20170108-040449</em>2068241472zeppelin_clock"
+}
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+<p><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 rebuild bundle. otherwise, provided from cache</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/visualizations/load[?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></p>
+
+<p><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>
+ <pre>
+{"status":"OK"}
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+<p><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>
+ <code>{"status":"OK"}</code>
+ </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/visualizationOrder</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>
+ <code>{"status":"OK","body":["zeppelin_horizontalbar","zeppelin-bubblechart"]}</code>
+ </td>
+ </tr>
+ </table></p>
+
+<p><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/visualizationOrder</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>
+ <code>["zeppelin-bubblechart", "zeppelin_horizontalbar"]</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Sample JSON response</td>
+ <td>
+ <code>{"status":"OK"}</code>
+ </td>
+ </tr>
+ </table></p>
+
+ </div>
+</div>
+
+
+ <hr>
+ <footer>
+ <!-- <p>© 2017 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>
+