zeppelin-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From k..@apache.org
Subject svn commit: r1800236 [23/23] - in /zeppelin/site/docs/0.8.0-SNAPSHOT: ./ interpreter/ quickstart/ setup/ setup/basics/ setup/deployment/ setup/operation/ setup/security/ setup/storage/ usage/ usage/display_system/ usage/dynamic_form/ usage/interpreter/...
Date Thu, 29 Jun 2017 07:02:52 GMT
Added: zeppelin/site/docs/0.8.0-SNAPSHOT/usage/rest_api/notebook_repository.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/usage/rest_api/notebook_repository.html?rev=1800236&view=auto
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/usage/rest_api/notebook_repository.html (added)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/usage/rest_api/notebook_repository.html Thu Jun 29 07:02:49
2017
@@ -0,0 +1,426 @@
+
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>Apache Zeppelin 0.8.0-SNAPSHOT Documentation: Apache Zeppelin notebook repository
REST API</title>
+    <meta name="description" content="This page contains Apache Zeppelin notebook repository
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="/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+    <link href="/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+    <link href="/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="/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+    <script src="/assets/themes/zeppelin/js/docs.js"></script>
+    <script src="/assets/themes/zeppelin/js/anchor.min.js"></script>
+    <script src="/assets/themes/zeppelin/js/toc.js"></script>
+    <script src="/assets/themes/zeppelin/js/lunr.min.js"></script>
+    <script src="/assets/themes/zeppelin/js/search.js"></script>    
+
+    <!-- atom & rss feed -->
+    <link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide
ATOM Feed">
+    <link href="/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="/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=""
+                 style="font-size: 15px; color: white;"> 0.8.0-SNAPSHOT
+              </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="/quickstart/install.html">Install</a></li>
+                <li><a href="/quickstart/explore_ui.html">Explore UI</a></li>
+                <li><a href="/quickstart/tutorial.html">Tutorial</a></li>
+                <li role="separator" class="divider"></li>
+                <li><a href="/quickstart/spark_with_zeppelin.html">Spark with
Zeppelin</a></li>
+                <li><a href="/quickstart/sql_with_zeppelin.html">SQL with Zeppelin</a></li>
+                <li><a href="/quickstart/python_with_zeppelin.html">Python 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">
+                <li class="title"><span>Dynamic Form</span></li>
+                <li><a href="/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="/usage/display_system/basic.html#text">Text Display</a></li>
+                <li><a href="/usage/display_system/basic.html#html">HTML Display</a></li>
+                <li><a href="/usage/display_system/basic.html#table">Table Display</a></li>
+                <li><a href="/usage/display_system/basic.html#network">Network</a></li>
+                <li><a href="/usage/display_system/angular_backend.html">Angular
Display using Backend API</a></li>
+                <li><a href="/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="/usage/interpreter/overview.html">Overview</a></li>
+                <li><a href="/usage/interpreter/interpreter_binding_mode.html">Interpreter
Binding Mode</a></li>
+                <li><a href="/usage/interpreter/user_impersonation.html">User
Impersonation</a></li>
+                <li><a href="/usage/interpreter/dependency_management.html">Dependency
Management</a></li>
+                <li><a href="/usage/interpreter/installation.html">Installing
Interpreters</a></li>
+                <!--<li><a href="/usage/interpreter/dynamic_loading.html">Dynamic
Interpreter Loading (Experimental)</a></li>-->
+                <li><a href="/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="/usage/other_features/publishing_paragraphs.html">Publishing
Paragraphs</a></li>
+                <li><a href="/usage/other_features/personalized_mode.html">Personalized
Mode</a></li>
+                <li><a href="/usage/other_features/customizing_homepage.html">Customizing
Zeppelin Homepage</a></li>
+                <li role="separator" class="divider"></li>
+                <li class="title"><span>REST API</span></li>
+                <li><a href="/usage/rest_api/interpreter.html">Interpreter API</a></li>
+                <li><a href="/usage/rest_api/zeppelin_server.html">Zeppelin Server
API</a></li>
+                <li><a href="/usage/rest_api/notebook.html">Notebook API</a></li>
+                <li><a href="/usage/rest_api/notebook_repository.html">Notebook
Repository API</a></li>
+                <li><a href="/usage/rest_api/configuration.html">Configuration
API</a></li>
+                <li><a href="/usage/rest_api/credential.html">Credential API</a></li>
+                <li><a href="/usage/rest_api/helium.html">Helium API</a></li>
+              </ul>
+            </li>
+
+            <li>
+              <a href="#" data-toggle="dropdown" class="dropdown-toggle">Setup<b
class="caret"></b></a>
+              <ul class="dropdown-menu">
+                <li class="title"><span>Basics</span></li>
+                <li><a href="/setup/basics/how_to_build.html">How to Build Zeppelin</a></li>
+                <li><a href="/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="/setup/deployment/docker.html">Docker Image
for Zeppelin</a></li>-->
+                <li><a href="/setup/deployment/spark_cluster_mode.html#spark-standalone-mode">Spark
Cluster Mode: Standalone</a></li>
+                <li><a href="/setup/deployment/spark_cluster_mode.html#spark-on-yarn-mode">Spark
Cluster Mode: YARN</a></li>
+                <li><a href="/setup/deployment/spark_cluster_mode.html#spark-on-mesos-mode">Spark
Cluster Mode: Mesos</a></li>
+                <li><a href="/setup/deployment/flink_and_spark_cluster.html">Zeppelin
with Flink, Spark Cluster</a></li>
+                <li><a href="/setup/deployment/cdh.html">Zeppelin on CDH</a></li>
+                <li><a href="/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="/setup/security/authentication_nginx.html">HTTP
Basic Auth using NGINX</a></li>
+                <li><a href="/setup/security/shiro_authentication.html">Shiro
Authentication</a></li>
+                <li><a href="/setup/security/notebook_authorization.html">Notebook
Authorization</a></li>
+                <li><a href="/setup/security/datasource_authorization.html">Data
Source Authorization</a></li>
+                <li role="separator" class="divider"></li>
+                <li class="title"><span>Notebook Storage</span></li>
+                <li><a href="/setup/storage/storage.html#notebook-storage-in-local-git-repository">Git
Storage</a></li>
+                <li><a href="/setup/storage/storage.html#notebook-storage-in-s3">S3
Storage</a></li>
+                <li><a href="/setup/storage/storage.html#notebook-storage-in-azure">Azure
Storage</a></li>
+                <li><a href="/setup/storage/storage.html#notebook-storage-in-zeppelinhub">ZeppelinHub
Storage</a></li>
+                <li><a href="/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="/setup/operation/configuration.html">Configuration</a></li>
+                <li><a href="/setup/operation/proxy_setting.html">Proxy Setting</a></li>
+                <li><a href="/setup/operation/upgrading.html">Upgrading</a></li>
+                <li><a href="/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="/usage/interpreter/overview.html">Overview</a></li>
+                <li role="separator" class="divider"></li>
+                <li><a href="/interpreter/spark.html">Spark</a></li>
+                <li><a href="/interpreter/jdbc.html">JDBC</a></li>
+                <li><a href="/interpreter/python.html">Python</a></li>
+                <li role="separator" class="divider"></li>
+                <li><a href="/interpreter/alluxio.html">Alluxio</a></li>
+                <li><a href="/interpreter/beam.html">Beam</a></li>
+                <li><a href="/interpreter/bigquery.html">BigQuery</a></li>
+                <li><a href="/interpreter/cassandra.html">Cassandra</a></li>
+                <li><a href="/interpreter/elasticsearch.html">Elasticsearch</a></li>
+                <li><a href="/interpreter/flink.html">Flink</a></li>
+                <li><a href="/interpreter/geode.html">Geode</a></li>
+                <li><a href="/interpreter/groovy.html">Groovy</a></li>
+                <li><a href="/interpreter/hbase.html">HBase</a></li>
+                <li><a href="/interpreter/hdfs.html">HDFS</a></li>
+                <li><a href="/interpreter/hive.html">Hive</a></li>
+                <li><a href="/interpreter/ignite.html">Ignite</a></li>
+                <li><a href="/interpreter/kylin.html">Kylin</a></li>
+                <li><a href="/interpreter/lens.html">Lens</a></li>
+                <li><a href="/interpreter/livy.html">Livy</a></li>
+                <li><a href="/interpreter/markdown.html">Markdown</a></li>
+                <li><a href="/interpreter/pig.html">Pig</a></li>
+                <li><a href="/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
+                <li><a href="/interpreter/r.html">R</a></li>
+                <li><a href="/interpreter/scalding.html">Scalding</a></li>
+                <li><a href="/interpreter/scio.html">Scio</a></li>
+                <li><a href="/interpreter/shell.html">Shell</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="/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="/development/helium/overview.html">Overview</a></li>
+                <li><a href="/development/helium/writing_application.html">Writing
Helium Application</a></li>
+                <li><a href="/development/helium/writing_spell.html">Writing
Helium Spell</a></li>
+                <li><a href="/development/helium/writing_visualization_basics.html">Writing
Helium Visualization: Basics</a></li>
+                <li><a href="/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="/setup/basics/how_to_build.html">How to Build Zeppelin</a></li>
+                <li><a href="/development/contribution/useful_developer_tools.html">Useful
Developer Tools</a></li>
+                <li><a href="/development/contribution/how_to_contribute_code.html">How
to Contribute (code)</a></li>
+                <li><a href="/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="">Mailing List</a></li>
+                <li><a target="_blank" href="">Apache Zeppelin Wiki</a></li>
+                <li><a target="_blank" href="">Stackoverflow Questions about
Zeppelin</a></li>
+              </ul>
+            </li>
+            <li>
+              <a href="/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 notebook repository 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 Notebook Repository 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>Notebook Repository REST API List</h2>
+
+<h3>List all available notebook repositories</h3>
+
+<p><table class="table-configuration">
+    <col width="200">
+    <tr>
+      <td>Description</td>
+      <td>This <code>GET</code> method returns all the available notebook
repositories.</td>
+    </tr>
+    <tr>
+      <td>URL</td>
+      <td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories</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>
+{
+  &quot;status&quot;: &quot;OK&quot;,
+  &quot;message&quot;: &quot;&quot;,
+  &quot;body&quot;: [
+    {
+      &quot;name&quot;: &quot;GitNotebookRepo&quot;,
+      &quot;className&quot;: &quot;org.apache.zeppelin.notebook.repo.GitNotebookRepo&quot;,
+      &quot;settings&quot;: [
+        {
+          &quot;type&quot;: &quot;INPUT&quot;,
+          &quot;value&quot;: [],
+          &quot;selected&quot;: &quot;ZEPPELIN_HOME/zeppelin/notebook/&quot;,
+          &quot;name&quot;: &quot;Notebook Path&quot;
+        }
+      ]
+    }
+  ]
+}
+        </pre>
+      </td>
+    </tr>
+  </table></p>
+
+<p><br/></p>
+
+<h3>Reload a notebook repository</h3>
+
+<p><table class="table-configuration">
+    <col width="200">
+    <tr>
+      <td>Description</td>
+      <td>This <code>GET</code> method triggers reloading and broadcasting
of the note list.</td>
+    </tr>
+    <tr>
+      <td>URL</td>
+      <td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories/reload</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>
+{
+  &quot;status&quot;: &quot;OK&quot;,
+  &quot;message&quot;: &quot;&quot;
+}
+        </pre>
+      </td>
+    </tr>
+  </table></p>
+
+<p><br/></p>
+
+<h3>Update a specific notebook repository</h3>
+
+<p><table class="table-configuration">
+    <col width="200">
+    <tr>
+      <td>Description</td>
+      <td>This <code>PUT</code> method updates a specific notebook repository.</td>
+    </tr>
+    <tr>
+      <td>URL</td>
+      <td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories</code></td>
+    </tr>
+    <tr>
+      <td>Success code</td>
+      <td>200</td>
+    </tr>
+    <tr>
+      <td>Fail code</td>
+      <td>
+        404 when the specified notebook repository doesn&#39;t exist <br/> 
+        406 for invalid payload <br/>
+        500 for any other errors
+      </td>
+    </tr>
+    <tr>
+      <td>Sample JSON input</td>
+      <td>
+        <pre>
+{
+  &quot;name&quot;:&quot;org.apache.zeppelin.notebook.repo.GitNotebookRepo&quot;,
+  &quot;settings&quot;:{
+    &quot;Notebook Path&quot;:&quot;/tmp/notebook/&quot;
+  }
+}
+        </pre>
+      </td>
+    </tr>
+    <tr>
+      <td>Sample JSON response</td>
+      <td>
+        <pre>
+{
+  &quot;status&quot;: &quot;OK&quot;,
+  &quot;message&quot;: &quot;&quot;,
+  &quot;body&quot;: {
+    &quot;name&quot;: &quot;GitNotebookRepo&quot;,
+    &quot;className&quot;: &quot;org.apache.zeppelin.notebook.repo.GitNotebookRepo&quot;,
+    &quot;settings&quot;: [
+      {
+        &quot;type&quot;: &quot;INPUT&quot;,
+        &quot;value&quot;: [],
+        &quot;selected&quot;: &quot;/tmp/notebook/&quot;,
+        &quot;name&quot;: &quot;Notebook Path&quot;
+      }
+    ]
+  }
+}
+        </pre>
+      </td>
+    </tr>
+  </table></p>
+
+  </div>
+</div>
+
+
+      <hr>
+      <footer>
+        <!-- <p>&copy; 2017 The Apache Software Foundation</p>-->
+      </footer>
+    </div>
+
+    
+  </body>
+</html>
+

Added: zeppelin/site/docs/0.8.0-SNAPSHOT/usage/rest_api/zeppelin_server.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/usage/rest_api/zeppelin_server.html?rev=1800236&view=auto
==============================================================================
--- zeppelin/site/docs/0.8.0-SNAPSHOT/usage/rest_api/zeppelin_server.html (added)
+++ zeppelin/site/docs/0.8.0-SNAPSHOT/usage/rest_api/zeppelin_server.html Thu Jun 29 07:02:49
2017
@@ -0,0 +1,363 @@
+
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>Apache Zeppelin 0.8.0-SNAPSHOT Documentation: Apache Zeppelin Server REST
API</title>
+    <meta name="description" content="This page contains Apache Zeppelin Server 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="/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+    <link href="/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+    <link href="/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="/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+    <script src="/assets/themes/zeppelin/js/docs.js"></script>
+    <script src="/assets/themes/zeppelin/js/anchor.min.js"></script>
+    <script src="/assets/themes/zeppelin/js/toc.js"></script>
+    <script src="/assets/themes/zeppelin/js/lunr.min.js"></script>
+    <script src="/assets/themes/zeppelin/js/search.js"></script>    
+
+    <!-- atom & rss feed -->
+    <link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide
ATOM Feed">
+    <link href="/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="/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=""
+                 style="font-size: 15px; color: white;"> 0.8.0-SNAPSHOT
+              </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="/quickstart/install.html">Install</a></li>
+                <li><a href="/quickstart/explore_ui.html">Explore UI</a></li>
+                <li><a href="/quickstart/tutorial.html">Tutorial</a></li>
+                <li role="separator" class="divider"></li>
+                <li><a href="/quickstart/spark_with_zeppelin.html">Spark with
Zeppelin</a></li>
+                <li><a href="/quickstart/sql_with_zeppelin.html">SQL with Zeppelin</a></li>
+                <li><a href="/quickstart/python_with_zeppelin.html">Python 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">
+                <li class="title"><span>Dynamic Form</span></li>
+                <li><a href="/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="/usage/display_system/basic.html#text">Text Display</a></li>
+                <li><a href="/usage/display_system/basic.html#html">HTML Display</a></li>
+                <li><a href="/usage/display_system/basic.html#table">Table Display</a></li>
+                <li><a href="/usage/display_system/basic.html#network">Network</a></li>
+                <li><a href="/usage/display_system/angular_backend.html">Angular
Display using Backend API</a></li>
+                <li><a href="/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="/usage/interpreter/overview.html">Overview</a></li>
+                <li><a href="/usage/interpreter/interpreter_binding_mode.html">Interpreter
Binding Mode</a></li>
+                <li><a href="/usage/interpreter/user_impersonation.html">User
Impersonation</a></li>
+                <li><a href="/usage/interpreter/dependency_management.html">Dependency
Management</a></li>
+                <li><a href="/usage/interpreter/installation.html">Installing
Interpreters</a></li>
+                <!--<li><a href="/usage/interpreter/dynamic_loading.html">Dynamic
Interpreter Loading (Experimental)</a></li>-->
+                <li><a href="/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="/usage/other_features/publishing_paragraphs.html">Publishing
Paragraphs</a></li>
+                <li><a href="/usage/other_features/personalized_mode.html">Personalized
Mode</a></li>
+                <li><a href="/usage/other_features/customizing_homepage.html">Customizing
Zeppelin Homepage</a></li>
+                <li role="separator" class="divider"></li>
+                <li class="title"><span>REST API</span></li>
+                <li><a href="/usage/rest_api/interpreter.html">Interpreter API</a></li>
+                <li><a href="/usage/rest_api/zeppelin_server.html">Zeppelin Server
API</a></li>
+                <li><a href="/usage/rest_api/notebook.html">Notebook API</a></li>
+                <li><a href="/usage/rest_api/notebook_repository.html">Notebook
Repository API</a></li>
+                <li><a href="/usage/rest_api/configuration.html">Configuration
API</a></li>
+                <li><a href="/usage/rest_api/credential.html">Credential API</a></li>
+                <li><a href="/usage/rest_api/helium.html">Helium API</a></li>
+              </ul>
+            </li>
+
+            <li>
+              <a href="#" data-toggle="dropdown" class="dropdown-toggle">Setup<b
class="caret"></b></a>
+              <ul class="dropdown-menu">
+                <li class="title"><span>Basics</span></li>
+                <li><a href="/setup/basics/how_to_build.html">How to Build Zeppelin</a></li>
+                <li><a href="/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="/setup/deployment/docker.html">Docker Image
for Zeppelin</a></li>-->
+                <li><a href="/setup/deployment/spark_cluster_mode.html#spark-standalone-mode">Spark
Cluster Mode: Standalone</a></li>
+                <li><a href="/setup/deployment/spark_cluster_mode.html#spark-on-yarn-mode">Spark
Cluster Mode: YARN</a></li>
+                <li><a href="/setup/deployment/spark_cluster_mode.html#spark-on-mesos-mode">Spark
Cluster Mode: Mesos</a></li>
+                <li><a href="/setup/deployment/flink_and_spark_cluster.html">Zeppelin
with Flink, Spark Cluster</a></li>
+                <li><a href="/setup/deployment/cdh.html">Zeppelin on CDH</a></li>
+                <li><a href="/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="/setup/security/authentication_nginx.html">HTTP
Basic Auth using NGINX</a></li>
+                <li><a href="/setup/security/shiro_authentication.html">Shiro
Authentication</a></li>
+                <li><a href="/setup/security/notebook_authorization.html">Notebook
Authorization</a></li>
+                <li><a href="/setup/security/datasource_authorization.html">Data
Source Authorization</a></li>
+                <li role="separator" class="divider"></li>
+                <li class="title"><span>Notebook Storage</span></li>
+                <li><a href="/setup/storage/storage.html#notebook-storage-in-local-git-repository">Git
Storage</a></li>
+                <li><a href="/setup/storage/storage.html#notebook-storage-in-s3">S3
Storage</a></li>
+                <li><a href="/setup/storage/storage.html#notebook-storage-in-azure">Azure
Storage</a></li>
+                <li><a href="/setup/storage/storage.html#notebook-storage-in-zeppelinhub">ZeppelinHub
Storage</a></li>
+                <li><a href="/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="/setup/operation/configuration.html">Configuration</a></li>
+                <li><a href="/setup/operation/proxy_setting.html">Proxy Setting</a></li>
+                <li><a href="/setup/operation/upgrading.html">Upgrading</a></li>
+                <li><a href="/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="/usage/interpreter/overview.html">Overview</a></li>
+                <li role="separator" class="divider"></li>
+                <li><a href="/interpreter/spark.html">Spark</a></li>
+                <li><a href="/interpreter/jdbc.html">JDBC</a></li>
+                <li><a href="/interpreter/python.html">Python</a></li>
+                <li role="separator" class="divider"></li>
+                <li><a href="/interpreter/alluxio.html">Alluxio</a></li>
+                <li><a href="/interpreter/beam.html">Beam</a></li>
+                <li><a href="/interpreter/bigquery.html">BigQuery</a></li>
+                <li><a href="/interpreter/cassandra.html">Cassandra</a></li>
+                <li><a href="/interpreter/elasticsearch.html">Elasticsearch</a></li>
+                <li><a href="/interpreter/flink.html">Flink</a></li>
+                <li><a href="/interpreter/geode.html">Geode</a></li>
+                <li><a href="/interpreter/groovy.html">Groovy</a></li>
+                <li><a href="/interpreter/hbase.html">HBase</a></li>
+                <li><a href="/interpreter/hdfs.html">HDFS</a></li>
+                <li><a href="/interpreter/hive.html">Hive</a></li>
+                <li><a href="/interpreter/ignite.html">Ignite</a></li>
+                <li><a href="/interpreter/kylin.html">Kylin</a></li>
+                <li><a href="/interpreter/lens.html">Lens</a></li>
+                <li><a href="/interpreter/livy.html">Livy</a></li>
+                <li><a href="/interpreter/markdown.html">Markdown</a></li>
+                <li><a href="/interpreter/pig.html">Pig</a></li>
+                <li><a href="/interpreter/postgresql.html">Postgresql, HAWQ</a></li>
+                <li><a href="/interpreter/r.html">R</a></li>
+                <li><a href="/interpreter/scalding.html">Scalding</a></li>
+                <li><a href="/interpreter/scio.html">Scio</a></li>
+                <li><a href="/interpreter/shell.html">Shell</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="/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="/development/helium/overview.html">Overview</a></li>
+                <li><a href="/development/helium/writing_application.html">Writing
Helium Application</a></li>
+                <li><a href="/development/helium/writing_spell.html">Writing
Helium Spell</a></li>
+                <li><a href="/development/helium/writing_visualization_basics.html">Writing
Helium Visualization: Basics</a></li>
+                <li><a href="/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="/setup/basics/how_to_build.html">How to Build Zeppelin</a></li>
+                <li><a href="/development/contribution/useful_developer_tools.html">Useful
Developer Tools</a></li>
+                <li><a href="/development/contribution/how_to_contribute_code.html">How
to Contribute (code)</a></li>
+                <li><a href="/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="">Mailing List</a></li>
+                <li><a target="_blank" href="">Apache Zeppelin Wiki</a></li>
+                <li><a target="_blank" href="">Stackoverflow Questions about
Zeppelin</a></li>
+              </ul>
+            </li>
+            <li>
+              <a href="/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 Server 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 Server 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>Zeppelin Server REST API list</h2>
+
+<h3>Get Zeppelin version</h3>
+
+<p><table class="table-configuration">
+    <col width="200">
+    <tr>
+      <td>Description</td>
+      <td>This <code>GET</code> method returns Zeppelin version</td>
+    </tr>
+    <tr>
+      <td>URL</td>
+      <td><code>http://[zeppelin-server]:[zeppelin-port]/api/version</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>
+{
+  &quot;status&quot;: &quot;OK&quot;,
+  &quot;message&quot;: &quot;Zeppelin version&quot;,
+  &quot;body&quot;: [
+    {
+      &quot;version&quot;: &quot;0.8.0&quot;,
+      &quot;git-commit-id&quot;: &quot;abc0123&quot;,
+      &quot;git-timestamp&quot;: &quot;2017-01-02 03:04:05&quot;
+    }
+  ]
+}
+        </pre>
+      </td>
+    </tr>
+  </table></p>
+
+<h3>Change the log level of Zeppelin Server</h3>
+
+<p><table class="table-configuration">
+    <col width="200">
+    <tr>
+      <td>Description</td>
+      <td>This <code>PUT</code> method is used to update the root logger&#39;s
log level of the server.</td>
+    </tr>
+    <tr>
+      <td>URL</td>
+      <td><code>http://[zeppelin-server]:[zeppelin-port]/api/log/level/&lt;LOG_LEVEL&gt;</code></td>
+    </tr>
+    <tr>
+      <td>Success code</td>
+      <td>200</td>
+    </tr>
+    <tr>
+      <td>Fail code</td>
+      <td>406</td>
+    </tr>
+    <tr>
+      <td>sample JSON response</td>
+      <td>
+        <pre>
+{
+  &quot;status&quot;: &quot;OK&quot;
+}
+        </pre>
+      </td>
+    </tr>
+    <tr>
+      <td>sample error JSON response</td>
+      <td>
+        <pre>
+{
+  &quot;status&quot;:&quot;NOT_ACCEPTABLE&quot;,
+  &quot;message&quot;:&quot;Please check LOG level specified. Valid values: DEBUG,
ERROR, FATAL, INFO, TRACE, WARN&quot;
+}
+        </pre>
+      </td>
+    </tr>
+  </table></p>
+
+  </div>
+</div>
+
+
+      <hr>
+      <footer>
+        <!-- <p>&copy; 2017 The Apache Software Foundation</p>-->
+      </footer>
+    </div>
+
+    
+  </body>
+</html>
+



Mime
View raw message