"Fossies" - the Fresh Open Source Software Archive

Member "geoserver-2.18.1/user/rest/about.html" (19 Nov 2020, 15961 Bytes) of package /linux/www/geoserver-2.18.1-htmldoc.zip:


The requested HTML page contains a <FORM> tag that is unusable on "Fossies" in "automatic" (rendered) mode so that page is shown as HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US" xml:lang="en-US">
    4 <head>
    5   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    6   
    7   <title>About &mdash; GeoServer 2.18.1 User Manual</title>
    8   <link rel="stylesheet" href="../_static/blueprint/screen.css" type="text/css" media="screen, projection" />
    9   <link rel="stylesheet" href="../_static/blueprint/print.css" type="text/css" media="print" /> 
   10   <!--[if IE]>
   11   <link rel="stylesheet" href="../_static/blueprint/ie.css" type="text/css" media="screen, projection" />
   12   <![endif]-->
   13   <link rel="stylesheet" href="../_static/default.css" type="text/css" />
   14   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
   15   <script type="text/javascript">
   16     var DOCUMENTATION_OPTIONS = {
   17         URL_ROOT:    '../',
   18         VERSION:     '2.18.1',
   19         COLLAPSE_MODINDEX: false,
   20         FILE_SUFFIX: '.html'
   21     };
   22   </script>
   23   <script type="text/javascript" src="../_static/jquery.js"></script>
   24   <script type="text/javascript" src="../_static/doctools.js"></script>
   25   <script type="text/javascript" src="../_static/searchtools.js"></script>
   26   <script type="text/javascript" src="../searchindex.js"></script>
   27   <link rel="shortcut icon" href="../_static/geoserver.ico"/>
   28       <link rel="search" title="Search" href="../search.html" />
   29       <link rel="top" title="GeoServer 2.18.1 User Manual" href="../index.html" />
   30       <link rel="up" title="REST" href="index.html" />
   31       <link rel="next" title="Fonts" href="fonts.html" />
   32       <link rel="prev" title="REST" href="index.html" />
   33 </head>
   34 <body class="rest/about">
   35   <div id="header" class="selfclear">
   36     <div class="wrap selfclear">
   37       <div id="logo"><a href="../index.html">GeoServer 2.18.1 User Manual</a></div>
   38       <ul id="top-nav">
   39         <li class="first"><a href="http://geoserver.org/about">About</a></li>
   40         <li><a href="http://blog.geoserver.org/">Blog</a></li>
   41         <li><a href="http://geoserver.org/download">Download</a></li>
   42         <!--<li><a href="../index.html">Documentation</a></li>-->
   43       </ul>
   44         <form id="quick-search" action="../search.html" method="get">
   45           <fieldset>
   46             <input type="hidden" name="check_keywords" value="yes" />
   47             <input type="hidden" name="area" value="default" />
   48             <input id="quick-search-query" type="text" name="q" accessKey="q" name="searchQuery.queryString" size="25" value="Search Documentation&hellip;" size="20" tabindex="3" onblur="if(this.value=='') this.value='Search Documentation&hellip;';" onfocus="if(this.value=='Search Documentation&hellip;') this.value='';" />
   49             <input id="quick-search-submit" type="image" value="Search" src="../_static/chrome/search_icon_green.png" />
   50           </fieldset>
   51         </form>
   52     </div><!-- /.wrap -->
   53   </div><!-- /#header -->
   54   <div id="main">
   55     <div class="wrap selfclear">
   56       <div id="content-left" class="content-border"></div>
   57       <div id="content">
   58 <ul id="breadcrumbs">
   59   
   60   <li><a href="../index.html">GeoServer 2.18.1 User Manual</a> &raquo;</li>
   61   <li><a href="index.html" accesskey="U">REST</a> &raquo;</li>
   62   <li>About</li>
   63 </ul>
   64 <ul id="relatedlinks" class="selfclear">
   65   <li class="first">
   66     <a href="../py-modindex.html" title="Python Module Index"
   67        accesskey="">modules</a></li>
   68   <li>
   69     <a href="fonts.html" title="Fonts"
   70        accesskey="N">next</a>|</li>
   71   <li>
   72     <a href="index.html" title="REST"
   73        accesskey="P">previous</a>|</li>
   74 </ul>
   75         
   76   <div class="section" id="about">
   77 <span id="rest-about"></span><h1>About<a class="headerlink" href="#about" title="Permalink to this headline"></a></h1>
   78 <p>The REST API allows you to set and retrieve information about the server itself.</p>
   79 <div class="admonition note">
   80 <p class="admonition-title">Note</p>
   81 <p>Read the <cite>API reference for /about/manifests &lt;manifests.yaml&gt;__</cite>.</p>
   82 </div>
   83 <div class="section" id="retrieving-component-versions">
   84 <h2>Retrieving component versions<a class="headerlink" href="#retrieving-component-versions" title="Permalink to this headline"></a></h2>
   85 <p><strong>Retrieve the versions of the main components: GeoServer, GeoTools, and GeoWebCache</strong></p>
   86 <p><em>Request</em></p>
   87 <div class="admonition-curl admonition">
   88 <p class="admonition-title">curl</p>
   89 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="o">-</span><span class="n">v</span> <span class="o">-</span><span class="n">u</span> <span class="n">admin</span><span class="p">:</span><span class="n">geoserver</span> <span class="o">-</span><span class="n">XGET</span> <span class="o">-</span><span class="n">H</span> <span class="s2">&quot;Accept: text/xml&quot;</span>
   90   <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">localhost</span><span class="p">:</span><span class="mi">8080</span><span class="o">/</span><span class="n">geoserver</span><span class="o">/</span><span class="n">rest</span><span class="o">/</span><span class="n">about</span><span class="o">/</span><span class="n">version</span><span class="o">.</span><span class="n">xml</span>
   91 </pre></div>
   92 </div>
   93 </div>
   94 <p><em>Response</em></p>
   95 <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;about&gt;</span>
   96  <span class="nt">&lt;resource</span> <span class="na">name=</span><span class="s">&quot;GeoServer&quot;</span><span class="nt">&gt;</span>
   97   <span class="nt">&lt;Build-Timestamp&gt;</span>11-Dec-2012 17:55<span class="nt">&lt;/Build-Timestamp&gt;</span>
   98   <span class="nt">&lt;Git-Revision&gt;</span>e66f8da85521f73d0fd00b71331069a5f49f7865<span class="nt">&lt;/Git-Revision&gt;</span>
   99   <span class="nt">&lt;Version&gt;</span>2.3-SNAPSHOT<span class="nt">&lt;/Version&gt;</span>
  100  <span class="nt">&lt;/resource&gt;</span>
  101  <span class="nt">&lt;resource</span> <span class="na">name=</span><span class="s">&quot;GeoTools&quot;</span><span class="nt">&gt;</span>
  102   <span class="nt">&lt;Build-Timestamp&gt;</span>04-Dec-2012 02:31<span class="nt">&lt;/Build-Timestamp&gt;</span>
  103   <span class="nt">&lt;Git-Revision&gt;</span>380a2b8545ee9221f1f2d38a4f10ef77a23bccae<span class="nt">&lt;/Git-Revision&gt;</span>
  104   <span class="nt">&lt;Version&gt;</span>9-SNAPSHOT<span class="nt">&lt;/Version&gt;</span>
  105  <span class="nt">&lt;/resource&gt;</span>
  106  <span class="nt">&lt;resource</span> <span class="na">name=</span><span class="s">&quot;GeoWebCache&quot;</span><span class="nt">&gt;</span>
  107   <span class="nt">&lt;Git-Revision&gt;</span>2a534f91f6b99e5120a9eaa5db62df771dd01688<span class="nt">&lt;/Git-Revision&gt;</span>
  108   <span class="nt">&lt;Version&gt;</span>1.3-SNAPSHOT<span class="nt">&lt;/Version&gt;</span>
  109  <span class="nt">&lt;/resource&gt;</span>
  110 <span class="nt">&lt;/about&gt;</span>
  111 </pre></div>
  112 </div>
  113 </div>
  114 <div class="section" id="retrieving-manifests">
  115 <h2>Retrieving manifests<a class="headerlink" href="#retrieving-manifests" title="Permalink to this headline"></a></h2>
  116 <p><strong>Retrieve the full manifest and subsets of the manifest as known to the ClassLoader</strong></p>
  117 <p><em>Request</em></p>
  118 <div class="admonition-curl admonition">
  119 <p class="admonition-title">curl</p>
  120 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="o">-</span><span class="n">v</span> <span class="o">-</span><span class="n">u</span> <span class="n">admin</span><span class="p">:</span><span class="n">geoserver</span> <span class="o">-</span><span class="n">XGET</span> <span class="o">-</span><span class="n">H</span> <span class="s2">&quot;Accept: text/xml&quot;</span>
  121   <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">localhost</span><span class="p">:</span><span class="mi">8080</span><span class="o">/</span><span class="n">geoserver</span><span class="o">/</span><span class="n">rest</span><span class="o">/</span><span class="n">about</span><span class="o">/</span><span class="n">manifest</span><span class="o">.</span><span class="n">xml</span>
  122 </pre></div>
  123 </div>
  124 </div>
  125 <div class="admonition note">
  126 <p class="admonition-title">Note</p>
  127 <p>The result will be a very long list of manifest information. While this can be useful, it is often desirable to filter this list.</p>
  128 </div>
  129 <p><strong>Retrieve manifests, filtered by resource name</strong></p>
  130 <div class="admonition note">
  131 <p class="admonition-title">Note</p>
  132 <p>This example will retrieve only resources where the <code class="docutils literal notranslate"><span class="pre">name</span></code> attribute matches <code class="docutils literal notranslate"><span class="pre">gwc-.*</span></code>.</p>
  133 </div>
  134 <p><em>Request</em></p>
  135 <div class="admonition-curl admonition">
  136 <p class="admonition-title">curl</p>
  137 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>curl -v -u admin:geoserver -XGET -H &quot;Accept: text/xml&quot;
  138   http://localhost:8080/geoserver/rest/about/manifest.xml?manifest=gwc-.*
  139 </pre></div>
  140 </div>
  141 </div>
  142 <p><em>Response</em></p>
  143 <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;about&gt;</span>
  144   <span class="nt">&lt;resource</span> <span class="na">name=</span><span class="s">&quot;gwc-2.3.0&quot;</span><span class="nt">&gt;</span>
  145     ...
  146   <span class="nt">&lt;/resource&gt;</span>
  147   <span class="nt">&lt;resource</span> <span class="na">name=</span><span class="s">&quot;gwc-core-1.4.0&quot;</span><span class="nt">&gt;</span>
  148     ...
  149   <span class="nt">&lt;/resource&gt;</span>
  150   <span class="nt">&lt;resource</span> <span class="na">name=</span><span class="s">&quot;gwc-diskquota-core-1.4.0&quot;</span><span class="nt">&gt;</span>
  151     ...
  152   <span class="nt">&lt;/resource&gt;</span>
  153   <span class="nt">&lt;resource</span> <span class="na">name=</span><span class="s">&quot;gwc-diskquota-jdbc-1.4.0&quot;</span><span class="nt">&gt;</span>
  154     ...
  155   <span class="nt">&lt;/resource&gt;</span>
  156   <span class="nt">&lt;resource</span> <span class="na">name=</span><span class="s">&quot;gwc-georss-1.4.0&quot;</span><span class="nt">&gt;</span>
  157     ...
  158   <span class="nt">&lt;/resource&gt;</span>
  159   <span class="nt">&lt;resource</span> <span class="na">name=</span><span class="s">&quot;gwc-gmaps-1.4.0&quot;</span><span class="nt">&gt;</span>
  160     ...
  161   <span class="nt">&lt;/resource&gt;</span>
  162   <span class="nt">&lt;resource</span> <span class="na">name=</span><span class="s">&quot;gwc-kml-1.4.0&quot;</span><span class="nt">&gt;</span>
  163     ...
  164   <span class="nt">&lt;/resource&gt;</span>
  165   <span class="nt">&lt;resource</span> <span class="na">name=</span><span class="s">&quot;gwc-rest-1.4.0&quot;</span><span class="nt">&gt;</span>
  166     ...
  167   <span class="nt">&lt;/resource&gt;</span>
  168   <span class="nt">&lt;resource</span> <span class="na">name=</span><span class="s">&quot;gwc-tms-1.4.0&quot;</span><span class="nt">&gt;</span>
  169     ...
  170   <span class="nt">&lt;/resource&gt;</span>
  171   <span class="nt">&lt;resource</span> <span class="na">name=</span><span class="s">&quot;gwc-ve-1.4.0&quot;</span><span class="nt">&gt;</span>
  172     ...
  173   <span class="nt">&lt;/resource&gt;</span>
  174   <span class="nt">&lt;resource</span> <span class="na">name=</span><span class="s">&quot;gwc-wms-1.4.0&quot;</span><span class="nt">&gt;</span>
  175     ...
  176   <span class="nt">&lt;/resource&gt;</span>
  177   <span class="nt">&lt;resource</span> <span class="na">name=</span><span class="s">&quot;gwc-wmts-1.4.0&quot;</span><span class="nt">&gt;</span>
  178     ...
  179   <span class="nt">&lt;/resource&gt;</span>
  180 <span class="nt">&lt;/about&gt;</span>
  181 </pre></div>
  182 </div>
  183 <p><strong>Retrieve manifests, filtered by resource property</strong></p>
  184 <div class="admonition note">
  185 <p class="admonition-title">Note</p>
  186 <p>This example will retrieve only resources with a property equal to <code class="docutils literal notranslate"><span class="pre">GeoServerModule</span></code>.</p>
  187 </div>
  188 <p><em>Request</em></p>
  189 <div class="admonition-curl admonition">
  190 <p class="admonition-title">curl</p>
  191 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>curl -u admin:geoserver -XGET -H &quot;Accept: text/xml&quot;
  192   http://localhost:8080/geoserver/rest/about/manifest.xml?key=GeoServerModule
  193 </pre></div>
  194 </div>
  195 </div>
  196 <p><em>Response</em></p>
  197 <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;about&gt;</span>
  198  <span class="nt">&lt;resource</span> <span class="na">name=</span><span class="s">&quot;control-flow-2.3.0&quot;</span><span class="nt">&gt;</span>
  199   <span class="nt">&lt;GeoServerModule&gt;</span>extension<span class="nt">&lt;/GeoServerModule&gt;</span>
  200   ...
  201  <span class="nt">&lt;/resource&gt;</span>
  202  ...
  203  <span class="nt">&lt;resource</span> <span class="na">name=</span><span class="s">&quot;wms-2.3.0&quot;</span><span class="nt">&gt;</span>
  204   <span class="nt">&lt;GeoServerModule&gt;</span>core<span class="nt">&lt;/GeoServerModule&gt;</span>
  205   ...
  206  <span class="nt">&lt;/resource&gt;</span>
  207 <span class="nt">&lt;/about&gt;</span>
  208 </pre></div>
  209 </div>
  210 <p><strong>Retrieve manifests, filtered by both resource name and property</strong></p>
  211 <div class="admonition note">
  212 <p class="admonition-title">Note</p>
  213 <p>This example will retrieve only resources where a property with named <code class="docutils literal notranslate"><span class="pre">GeoServerModule</span></code> has a value equal to <code class="docutils literal notranslate"><span class="pre">extension</span></code>.</p>
  214 </div>
  215 <p><em>Request</em></p>
  216 <div class="admonition-curl admonition">
  217 <p class="admonition-title">curl</p>
  218 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>curl -u admin:geoserver -XGET -H &quot;Accept: text/xml&quot;
  219   http://localhost:8080/geoserver/rest/about/manifest.xml?key=GeoServerModule&amp;value=extension
  220 </pre></div>
  221 </div>
  222 </div>
  223 </div>
  224 </div>
  225 
  226 
  227       <div class="selfclear pagination-nav">
  228           <div class="leftwise"><strong>Previous</strong>: <a href="index.html" title="previous chapter">REST</a></div>
  229           <div class="rightwise"><strong>Next</strong>: <a href="fonts.html" title="next chapter">Fonts</a></div>
  230       </div>
  231       </div><!-- /#content> -->
  232       <div id="content-right" class="content-border"></div>
  233   <div id="sidebar" class="contrast">
  234       <div id="toc" class="section">
  235         <h3 class="pngfix">Table Of Contents</h3>
  236         <ul>
  237 <li><a class="reference internal" href="#">About</a><ul>
  238 <li><a class="reference internal" href="#retrieving-component-versions">Retrieving component versions</a></li>
  239 <li><a class="reference internal" href="#retrieving-manifests">Retrieving manifests</a></li>
  240 </ul>
  241 </li>
  242 </ul>
  243 
  244         <div class="section-footer"></div>
  245       </div>
  246         <div class="section">
  247           <h3>Continue Reading</h3>
  248           <ul>
  249             <li>Previous: <a href="index.html" title="previous chapter">REST</a></li>
  250             <li>Next: <a href="fonts.html" title="next chapter">Fonts</a></li>
  251           </ul>
  252         </div>
  253         <div class="section">
  254         <h3>This Page</h3>
  255         <ul class="this-page-menu">
  256                 
  257         <li><a href="https://github.com/geoserver/geoserver/tree/master/doc/en/user/source/rest/about.rst">Edit</a></li>
  258         </ul>
  259         </div>
  260   </div><!-- /#sidebar -->
  261   </div><!-- /.wrap> -->
  262 </div><!-- /#main -->
  263 <div id="footer">
  264   <div class="wrap">
  265     &copy; Copyright 2020, Open Source Geospatial Foundation. License <a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons Attribution</a>.
  266     Last updated on Nov 19, 2020.
  267     Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
  268   </div><!-- /.wrap> -->
  269 </div><!-- /#footer -->
  270   </body>
  271 </html>